mirror of
https://github.com/adidas/api-guidelines.git
synced 2025-10-25 15:19:19 +00:00
37 lines
1.8 KiB
Markdown
37 lines
1.8 KiB
Markdown
# adidas API Guidelines
|
|
**DRAFT** | [**Read online at GitBook**](https://adidas-group.gitbooks.io/api-guidelines/content/)
|
|
|
|
This document represents the guidelines for all APIs created the within adidas group.
|
|
|
|
## Motivation
|
|
The ultimate goal of these guidelines is to facilitate the work and minimize the effort of all API users while protecting their investment, thus encouraging API adoption.
|
|
|
|
The guidelines should lay down the foundation for collaboration, achieving stability without rigidity while maintaining extensibility for the future.
|
|
|
|
## Guidelines
|
|
The API Guidelines are split into several levels:
|
|
|
|
|
|
|
|
The **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. Finally, **Evolution and Execution guidelines** define the rules for achieving the desired architectural qualities of systems.
|
|
|
|
---
|
|
|
|
These Guidelines are available for online reading at [GitBook](https://apidesigner.gitbooks.io/adidas-api-guidelines/content/). The source can be found on [GitHub](https://github.com/adidas-group/api-guidelines).
|
|
|
|
|
|
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](https://www.ietf.org/rfc/rfc2119) for details.
|
|
|
|
|
|
---
|
|
|
|
_Please contact [Zdenek.Nemec@externals.adidas-group.com](mailto:Zdenek.Nemec@externals.adidas-group.com) in the case of questions._
|