-
Notifications
You must be signed in to change notification settings - Fork 152
REST Resources
A key principle of REST involves separating your API into logical resources. These resources are manipulated using HTTP requests where the method (GET, POST, PUT, PATCH, DELETE) has specific meaning.
A REST resource is anything that can be referenced through the REST API.
Resources:
- are concrete concepts (e.g., cars, payments, articles, bills, ...)
- are coarse grained (i.e., high level)
- use nouns rather than verbs
- are associated with a specific URI (e.g., /api/v1/employees)
- URI should be descriptive and well structured
The goal of REST resources is to expose a uniform interface as described in the previous section.
Although the internal models of your application may map neatly to resources, it isn't necessarily a one-to-one mapping. Avoid leaking implementation details out to your API.
This project is distributed under the terms of the EUPL FOSS license
REST Resources Design Workflow
REST Resources Single items and collections
REST Resources Many to many Relations
REST Resources Relations expansion
HTTP Status Codes Success (2xx)
HTTP Status Codes Redirection (3xx)
HTTP Status Codes Client Error (4xx)
HTTP Status Codes Server Error (5xx)
Pagination Out of range/bounds
Long-running Operations Example
Concurrency vs Delete operation
Caching and conditional requests About
Caching and conditional requests Rules
Caching and conditional requests HTTP headers
Error handling Example with a single error
Error handling Example with multiple errors
Error handling Example with parameters
Error handling Example with additional metadata
Bulk operations HTTP status codes
Bulk operations Resources naming convention
Bulk operations Creation example
Bulk operations Update example
Bulk operations Create and update example
File upload Simple file upload
File upload Simple file upload example
File upload Complex file upload
File upload Complex file upload example
REST Security General recommendations
REST Security Insecure direct object references