-
Notifications
You must be signed in to change notification settings - Fork 152
Redirections
If, for whichever reason, your API needs to move, either temporarily or permanently and you don't want to break existing clients, then you should redirect them automatically.
Your API clients should assume that any request may result in a redirection. Receiving an HTTP redirection is not an error and clients should follow the redirect.
Redirect responses SHOULD always provide a Location header field containing the URI of the resource to which the client should repeat the requests.
When a redirection is permanent, you should return a 301 status code. It means that the URI used by the client make the request has been superseded by the one specified in the Location header field of the response. This and all future requests should be directed to the new URI.
When a redirection is temporary, you SHOULD return a 303 or 307 status code (see the status codes table for more guidance).
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