My Restful API Best practice notes

RESTFUL api design

https://stackoverflow.blog/2020/03/02/best-practices-for-rest-api-design/

Reallife API Examples

• https://docs.stripe.com/api/products/object
• https://developer.box.com/reference/
• https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-group-issues
• https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-groups/#api-rest-api-3-group-user-post
• https://developer.spotify.com/documentation/web-api
• https://docs.oracle.com/en/cloud/paas/content-cloud/rest-api-users-groups/rest-endpoints.html
• https://phauer.com/2015/restful-api-design-best-practices/#keep-business-logic-on-the-server-side
• https://support.intershop.com/kb/index.php

Set status of the Task.

• https://www.zoho.com/mail/help/api/put-change-task-reminder.html
• https://learn.microsoft.com/en-us/rest/api/batchservice/task/update?tabs=HTTP
• https://my.axerosolutions.com/spaces/5/communifire-documentation/wiki/view/595/rest-api-get-content-list
• https://forum.asana.com/t/updating-task-status-value-automatically-using-api/173738

Pagination/filtering/sorting

• https://www.atatus.com/blog/rest-api-design-filtering-sorting-and-pagination/#:~:text=Optimize%20REST%20API%20design%20with%20filtering,%20sorting,%20and

How to use Patch Verb properly

• https://documentation.aucerna.app/planningspace/16.5/API/SP0/Web-API/PlanningSpace-Web-API-Guide-165/Content/Web%20API/Using%20PATCH%20requests.htm

• https://stackoverflow.com/questions/55264780/custom-update-actions-in-restful-services

• https://stackoverflow.com/questions/28459418/use-of-put-vs-patch-methods-in-rest-api-real-life-scenarios

Rate limiting

• https://developers.aprimo.com/marketing-operations/rest-api/rate-limits/

Performance improvement

1. Pagination
2. Async Logging
3. Caching
4. Payload Compression
5. Connection Pools