Notes
Constraints:
- Uniform interface: however the API is implemented, implement it the same way for the entire API
- Everything you need to manipulate the resource is in the response
- Manipulate the resource at the same URI
- Self-descriptive messages
- Hypermedia as the Engine of Application State (HATEOAS)
- Stateless: server doesn't keep track of what happens from one request to the next
- Cacheable: clients are allowed to cache responses; responses must implicitly or explicitly define themselves as able to be cached
- Client-server: clients have know knowledge of hos the server stores the data; servers have no knowledge of how the client tracks state
- Layered system: The data server might be behind several layers of caching, API layer, etc.
Verbs:
- GET - read information
- POST - Create new information
- DELETE - Delete the information
- PUT - Replace the information
- PATCH - Change the information
- 204 response code
- ETAG: hash of the resource. PATCH plus ETAG is more reliable than a PUT in the case that the data has been modified in between the original GET request and the PATCH request.
More Information
File Attachments
