REST API Learning Notes

REST API Architecture

HTTP Verb	Entire Collection (Example: customers)	Specific Item (Example: customer/[id])
GET	200 (Ok), list of customers. Use pagination, sorting and filtering to navigate big lists.	200 (Ok) single customer. 404 (Not Found), if ID is not found or invalid.
PUT/PATCH	404 (Not Founc), unless you want to update/replace every resource in the entire collection.	200 (Ok) or 204 (No Content). 404 (Not Found), if ID is not found or invalid.
POST	201 (Created). “Location” header with link to /customer/[id] containing new ID.	404 (Not Found).
DELETE	404 (Not Found), unless you want to delete the whole collection–not often desirable.	200 (Ok). 404 (Not Found), if ID is not found or invalid.

Resource Links

• https://stackoverflow.com/questions/671118/what-exactly-is-restful-programming/671508#671508
• https://stackoverflow.com/questions/28510876/is-my-api-a-restful-api
• https://stackoverflow.com/questions/671118/what-exactly-is-restful-programming/671132#671132
• https://www.restapitutorial.com/lessons/restquicktips.html

Back to articles