Best Practices for Naming REST API URIs

From NovaOrdis Knowledge Base
Revision as of 00:02, 14 February 2024 by Ovidiu (talk | contribs) (→‎Internal)
Jump to navigation Jump to search

Internal

Use Nouns to Name URIs

A REST API endpoint has a URL at which it can be accessed: https://example.com. Subdirectories of the URL denote different resources, which are accessed with URIs.

In general, URIs should be named with nouns that specify the content of the resource, rather than using a verb for the function performed. This is because CRUD operations should already be specified in the HTTP request.

Example:

https://example.com/users

https://example.com/user/{id}

TODO