Guidelines for API design at adidas (Read online at GitBook)
The goal of this document is to facilitate the work and minimize the effort of all API users while protecting their investment and encouraging API adoption.
The guidelines lay down the foundation for collaboration, stability, and extensibility.
The API Guidelines are split into several levels:
Core Principles define the general rules that MUST be followed at throughout the full API lifecycle at any level.
Protocol guidelines define the protocols used within the organization.
The Message guidelines define the structure and semantics of messages used to exchange information.
The Application guidelines define the definition and use of application-specific semantics.
Evolution and Execution guidelines define the rules for achieving the desired architectural qualities of systems.
The CAPITALIZED words throughout these guidelines have a special meaning:
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC2119.
Refer to RFC2119 for details.
Please contact [email protected] in the case of questions.