Best Practices for Naming REST API URIs: Difference between revisions
Jump to navigation
Jump to search
| Line 4: | Line 4: | ||
=Use Nouns to Name URIs= | =Use Nouns to Name URIs= | ||
A REST API endpoint has a URL at which it can be accessed: https | 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. | 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. | ||
| Line 10: | Line 10: | ||
Example: | Example: | ||
https | https://example.com/users | ||
https://example.com/user/{id} | https:://example.com/user/{id} | ||
=TODO= | =TODO= | ||
Revision as of 00:02, 14 February 2024
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}