REST APIs Notes and References
Posted on Sun 12 February 2017 in REST • 1 min read
After working to create a REST API and client recently, here are some notes and resources I found useful. I’ll keep adding to this as I find new info.
General notes
-
Resource collection names should always be plural.
-
Depending on who (client vs server) names resources, creation switches between
PUT
/POST
:- client names resources:
PUT /kittens/<my_kittens_name>
- creates a resource there
- server names resources:
POST /things
- Creates a newthing
at/things/<autogened_id>
, with that ID returned in the response to the post
- client names resources:
Some useful references
-
RESTful API Design Guides
Have you got any other good general rules, notes, or references to add?