2 ms·
1. Make the API well documented. Make it clear how to authenticate, request/response format, along with examples. 2. Repeat (1) 3. Make endpoints self explana
by lowcoderev 5y ago
1. Make the API well documented. Make it clear how to authenticate, request/response format, along with examples.
2. Repeat (1)
3. Make endpoints self explanatory. For example -
GET /users - To list all users
POST /users - To create a user
PUT /users/:userId - To update a user profile
PATCH /users/:userId - To patch a user profile (Great if you can support JSONPatch syntax)
Never add unnecessary verbs in the route like /users/create which can easily be represented by the HTTP Request Method.
Just my few cents