adidas API Guidelines

Guidelines for API design at adidas (Read online at GitBook)

Motivation

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.

Guidelines

The API Guidelines are split into two main parts:

• General Guidelines
• API type-specific Guidelines

The general guidelines section discusses the core principles relevant to any kind of API. The API type-specific section further defines the guidelines specific to a given architectural style or API technique (such as REST, Kafka or GraphQL API).

How to read the Guidelines

These Guidelines are available for online reading at GitBook its source can be found on GitHub.

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.

Questions & Comments

Please contact Zdenek.Nemec@externals.adidas-group.com in the case of questions.