-
Notifications
You must be signed in to change notification settings - Fork 152
REST Constraints
- client server
- the uniform interface provided by the REST Web Service separates clients from servers
- stateless
- no client context is stored on the server between requests
- each request contains all the information necessary to service the request
- session state is held by the client
- cacheable
- intermediaries can cache responses
- responses must implicitly or explicitly define themselves as cacheable, or not, to prevent clients from reusing stale or inappropriate data
- layered
- intermediary servers can be placed between the client and the server to improve scalability, provide load balancing, etc
- uniform interface
- identification of resources
- individual resources are identified in requests (for example using URIs for HTTP-based RESTful APIs)
- everything has an id (:warning: expose UUIDs, not database identifiers!)
- resources are conceptually separate from the representations that are returned to the client
- the server may send data from its database as JSON or XML for example, none of which are the server's internal representation
- manipulation of resources through these representations
- when a client holds a representation of a resource, it has enough information to modify or delete the resource
- self-descriptive message
- each message includes enough information to describe how to process the message (e.g., which parser to invoke may be specified by an Internet media type (i.e., MIME type)
- identification of resources
- hypermedia as the engine of application state (HATEOAS)
- resource representations come along with hyperlinks making it easier for clients to identify possible actions
- clients don't assume that any particular action is available for any particular resources
For a more detailed overview, check out the REST Wikipedia page.
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