Mirrors/api-guidelines
1
0
Fork 0
mirror of https://github.com/adidas/api-guidelines.git synced 2025-10-25 15:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add naming conventions for collections - plurality

Browse Source
This commit is contained in:
Andrzej
2018-12-13 11:19:56 +01:00
parent 6e5a0f5965
commit a4ba3a6880
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
rest-api-guidelines/quality/evolution/naming-conventions.md
View File

@@ -13,6 +13,14 @@ Every identifier **MUST** be in American English and written in `lowercase`. An
Every URI **MUST** follow the General Rules except for the `camelCase` rule. Instead, a hyphen \(`-`\) **SHOULD** be used to delimit combined words \(kebab-case\). Besides, a URI **MUST NOT** end with a trailing slash \(`/`\).
Plural nouns SHOULD be used in the URI where appropriate to identify collections of data resources (e.g. ``/orders``, ``/products``).
An individual resource in a collection of resources MAY exist directly beneath the collection URI. (e.g. ``/orders/{order_id}``).
Sub-resource collections MAY exist directly beneath an individual resource. This should convey a relationship to another collection of resources (e.g. ``/orders/{order_id}/items``).
Sub-resource individual resources MAY exist, but should be avoided in favor of top-level resources. (e.g. ``/orders/{order_id}/items/{item_id}``).
#### Example
A well-formed URI: