A REST-style API models data as resources. Use nouns in URLs and HTTP methods to communicate operations.
- GET /users
- GET /users/10
- POST /users
- PATCH /users/10
- DELETE /users/10
Consistent endpoint naming makes APIs easier for frontend and third-party developers to understand.
Deep dive
Resource naming
Prefer clear resource-oriented URLs such as /users and /orders/123. Keep naming consistent and avoid mixing unrelated conventions across endpoints.
Versioning
When an API must evolve without breaking existing clients, plan a versioning strategy such as URL, header, or media-type versioning.
ADVERTISEMENT