README.md

Every team is accountable to respect these standards during API development, and every member is encouraged to work collaboratively with members of the API Community of Practice to improve these guidelines.

In the case of an evolution of these API standards, the following rules must be followed:

• Existing APIs should not be systematically changed, although this is advisable,
• New APIs must respect the current version of the standards.

This document uses the terms RIGHT, SHOULD, MUST, MUST as keywords to define the requirement levels of a specification as defined in RFC 2119.

Table des matières

• Basic Principles
  • API First
  • Compatibility
  • Documentation
  • REST
• Message
  • Data and representation
  • Business validations
  • Business errors
  • Exceptions
  • JSON Payload
• Request
  • Asynchronism
  • Impersonation
  • JSON Patch
  • Localisation
  • Paging
• Nomenclature
  • General rules
  • URI
  • Versioning
• Protocole
  • HTTP
  • TLS
• Security
• Exploitation
  • Environments
  • Monitoring