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

GitBook: [master] 102 pages and one asset modified

Browse Source
This commit is contained in:
apidesigner
2018-07-23 07:49:01 +00:00
committed by gitbook-bot
parent af88d15fd0
commit 3b81882249
68 changed files with 850 additions and 712 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
general-guidelines/json.md
View File

@@ -1,9 +1,11 @@
# JSON Format Conventions
# JSON
Any JSON-based message **MUST** conform to the following rules:
1. All JSON field names **MUST** follow the [Naming Conventions](https://adidas-group.gitbooks.io/api-guidelines/content/evolution/naming-conventions.html) (`camelCase`, American English, etc.)
1. Field names **MUST** be ASCII alpha num characters, underscore (`_`) or dollar sign (`$`)
1. Boolean fields **MUST NOT** be of `null` value
1. Fields with `null` value **SHOULD** be omitted
1. Empty arrays and objects **SHOULD NOT ** be `null` (use `[]` or `{}` instead)
1. Array field names **SHOULD** be plural (e.g. `"orders": []`)
1. All JSON field names **MUST** follow the [Naming Conventions ](../rest-api-guidelines/quality/evolution/naming-conventions.md)\(`camelCase`, American English, etc.\)
2. Field names **MUST** be ASCII alpha num characters, underscore \(`_`\) or dollar sign \(`$`\)
3. Boolean fields **MUST NOT** be of `null` value
4. Fields with `null` value **SHOULD** be omitted
5. Empty arrays and objects **SHOULD NOT** be `null` \(use `[]` or `{}` instead\)
6. Array field names **SHOULD** be plural \(e.g. `"orders": []`\)