-
Notifications
You must be signed in to change notification settings - Fork 152
Concurrency Headers to use
To support optimistic concurrency control, your API SHOULD return the following HTTP headers along with all resource representations (for single items):
- ETag
- Last-Modified
For collections, the ETag values will be provided in the metadata (see later sections).
An ETag is an opaque identifier assigned to a specific version of a resource found at a given URL.
If the resource representation at that URL ever changes, a new ETag MUST be assigned by your API
The ETag value MUST be a collision-resistant hash of the resource's content
The ETag MAY for example be a SHA-512 hash of the representation or anything else that makes sense. You could also choose to combine the UUID of an entity with its last update timestamp and make a hash of that...
When the client updates a resource, it MUST provide an up to date ETag value in the If-Match HTTP header in his request (see conditional requests section). The server can then compare that ETag with the ETag of the latest version of the resources.
If both ETag values match, then it means that the client has the latest/up to date version, thus the update can go through.
If the client has a different ETag value (i.e., outdated or invalid), then it means that it tries to update stale data. In that case, a 412 (Precondition Failed) error SHOULD be returned.
If the server expects a conditional request for update/delete operations and it isn't present in the client request, then it SHOULD return a 428 (Precondition Required)
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