-
Notifications
You must be signed in to change notification settings - Fork 152
REST Resources Single items and collections
There are two major types of resources to consider: collections and single items (also called documents):
Examples
- collection:
/api/v1/cars
- document (single item):
/api/v1/cars/123
You could also consider a more fine grained classification:
- document: akin to an object instance
- singular noun
- collection: server-managed directory of resources. Clients MAY propose new resources to be added but it's up to the collection to choose to create a new resource or not. A collection resource chooses what it wants to contain and decides the URIs of each contained resource
- plural noun
- store: client-managed resource repository. A store resource lets an API client put resource in, get them back out, and decide when to delete them. Each stored resource has an URI that was chosen by a client when it was initially put into the store
- plural noun
- controller: a controller resource models a procedural concept. Controller resources are like executable functions or actions. Check out the section about Actions for more details verb or verb phrase
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