THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
Something we will follow:
for unknown attributes in the request, we will throw an error with a whole list of all of them
for all the response, we prefer HATEOAS, such as: return resource link in the response of create/update/delete; add resource url for sub resources(region/indexes)
http status code: 201 and 409 for create, 204 and 404 for delete, 200 and 404 for put to update
- camelCase is for all the key in the request and response body
some refer:
1 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md
2 https://developer.github.com/v3/
3 https://codeplanet.io/principles-good-restful-api-design/
4 https://blog.florimond.dev/restful-api-design-13-best-practices-to-make-your-users-happy
5 https://blog.mwaysolutions.com/2014/06/05/10-best-practices-for-better-restful-api/