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

Merge pull request #12 from adidas/naming-conventions

Browse Source 
Add naming conventions for collections - plurality
This commit is contained in:
Jesus de Diego
2021-02-18 15:46:40 +00:00
committed by GitHub
parent 0c084717f7 f8303684a4
commit e9c7747331
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -13,6 +13,10 @@ 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}``).
#### Example
A well-formed URI: