REST API Design Best Practices
Core Principles
Design APIs that are:
Easy to read and work with
Hard to misuse
Complete and concise
Naming and URL Structure
Resource Naming
Use nouns to represent resources, not verbs
Good: /items, /employees
Bad: /createItems, /getEmplo...
tigerabrodi.blog4 min read
Oliver Ramstedt
Great read! I'll have all new REST API devs read this before letting them loose haha.
One change i would make though is regarding documentation. As this is a 'best practice' guide i would not suggest OpenAPI specifically as there are many ways to document API's. I think the important lesson is to just document the endpoint in a way that makes sense in the dev environment.