Skip to content

Instantly share code, notes, and snippets.

@strika

strika/rest-design.txt

Last active August 29, 2015 14:14
Show Gist options
  • Save strika/2d5537a5a199aea7b20b to your computer and use it in GitHub Desktop.
Save strika/2d5537a5a199aea7b20b to your computer and use it in GitHub Desktop.
Download ZIP
Turning requirements into read/write resources
Raw
rest-design.txt
1. Figure out the data set
2. Split the data set into resources.
For each kind of resource:
3. Name the resources with URIs.
4. Expose a subset of the uniform interface.
5. Design the representation(s) accepted from the client.
6. Design the representation(s) served to the client.
7. Integrate this resource into eisting resources, using hypermedia links and forms.
8. Consider the typical course of events: what's supposed to happen?
9. Consider error conditions: what might go wrong?
Take from the book RESTful Web Services by Leonard Richardson & Sam Ruby
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment