Skip to content

Resource Naming

All path segments of a resource URL that represent concepts (e.g., shippers, driver, primary-role, colors) MUST be encoded in US/American English.

The primary action being performed on a resource MUST be expressed via the appropriate HTTP verb. Resource URLs SHOULD include descriptive, domain-relevant action names in their URL path.

Example

POST /items/select-lowest-prices

Nonexample

GET /items/select-lowest-prices

When a resource URL includes a descriptive action name in its URL path, the action name MUST be the final path segment of the URL and the action MUST be invoked using a POST HTTP verb.

Example

POST /printer/{prid}/pages/{pid}/print

Nonexample

POST /print/printer/{prid}/pages/{pid}