mirror of
https://github.com/adidas/api-guidelines.git
synced 2025-10-25 15:19:19 +00:00
44 lines
1.8 KiB
Markdown
44 lines
1.8 KiB
Markdown
# Introduction
|
|
|
|
|
|
|
|
## adidas API Guidelines
|
|
|
|
_Guidelines for API design and development at adidas_ \([Read online at GitBook](https://adidas.gitbook.io/api-guidelines/)\)
|
|
|
|
### 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](general-guidelines/general-guidelines.md)
|
|
* API type-specific Guidelines
|
|
* [REST APIs Guidelines](rest-api-guidelines/rest.md)
|
|
* [Kafka Guidelines](kafka-guidelines/kafka.md)
|
|
|
|
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](https://apidesigner.gitbooks.io/adidas-api-guidelines/content/) its source can be found on [GitHub](https://github.com/adidas-group/api-guidelines).
|
|
|
|
The CAPITALIZED words throughout these guidelines have a special meaning:
|
|
|
|
> ```text
|
|
> 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](https://www.ietf.org/rfc/rfc2119) for details.
|
|
|
|
### Questions & Comments
|
|
|
|
_Please contact_ [_Zdenek.Nemec@externals.adidas-group.com_](mailto:Zdenek.Nemec@externals.adidas-group.com) _in the case of questions._
|
|
|