Caching and conditional requests About
In order to optimize your API, you MAY add support for caching and conditional requests. Although, don't try to add caching to your API unless you know you need to; there's a nice quote from Phil Harton that you should keep in mind:
"There are only two hard things in Computer Science: cache invalidation and naming things". Caching will bite you if not implemented properly.
By adding support for caching and conditional requests, you can:
- eliminate some security risks
- for example: you could avoid that sensitive data be cached by intermediaries and clients (you cannot ensure it but you can ask nicely)
- gain performance and client-perceived latency
- increase reliability
- reduce the server load
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