JavaScript required
We’re sorry, but Coda doesn’t work properly without JavaScript enabled.
Skip to content
Gallery
Mile V3
Introduction
API Design Guide
UI UX Design Guide
Infrastructure
Module Configuration
Product Lifecycle
Roadmap
TDL
Billing Module
More
Share
Explore
API Design Guide
DM
Dika Maheswara
The objective here is to have an easy to understand API with standardized convention
Some of the keypoints for our design guide are
Divide API into collection of resources
Auth
Task
Package
Warehouse
Transport
Internal
Optimize
Whatsapp
Use the standard method of POST, GET, PUT, PATCH, and DELETE
Use custom method only when necessary
Differentiate getting a single resource and a list of resource using GET
resource/list
or GET
resource/ids/{:id}
Every API should have
JWT Auth
and
rate limitation
middleware
API should return response of status code of 2XX for success and 4XX for failure
Every API built should have unit testing attached with it
References
https://cloud.google.com/apis/design
https://developer.twitter.com/en/docs/api-reference-index
3.
https://stripe.com/blog/idempotency
Want to print your doc?
This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
Ctrl
P
) instead.