API Guidelines
Search
⌃K
Comment on page

JSON

Any JSON-based message MUST conform to the following rules:
  1. 1.
    All JSON field names MUST follow the Naming Conventions (camelCase, American English, etc.)
  2. 2.
    Field names MUST be ASCII alpha num characters, underscore (_) or dollar sign ($)
  3. 3.
    Boolean fields MUST NOT be of null value
  4. 4.
    Fields with null value SHOULD be omitted
  5. 5.
    Empty arrays and objects SHOULD NOT be null (use [] or {} instead)
  6. 6.
    Array field names SHOULD be plural (e.g. "orders": [])

Validation

All API designers MUST validate the definition of the payloads in requests/responses with the JSON Schema for the defined structure prior to the publication of the API Contract in SwaggerHub.
The publication of the JSON schema corresponding to the expected payloads in the bodies of requests and responses SHOULD be kept up to date according to the evolution of the API.
General Guidelines - Previous
Rules for Extending
Next - General Guidelines
Security
Last modified 2yr ago