-
Notifications
You must be signed in to change notification settings - Fork 1
Rest API design checklist
ygokirmak edited this page May 1, 2018
·
4 revisions
All our REST APIs should follow the rules below;
- All resources should provide 5 standard methods as List, Get, Create, Update, and Delete. ( this is same as Google APIs). List and Get should be implemented with HTTP Get, Create should be HTTP.POST, Update should be HTTP.PUT and HTTP.Delete for delete
- Filtering should be implemented with GET parameters.
- Use subresource queries for getting relational resources like
activities of a person(12)
, so instead of/api/activities/person/12
or/api/activities?person=12
useapi/persons/12/activities
. - Use resource view pattern to return required fields. https://cloud.google.com/apis/design/design_patterns