adidas API Guidelines
Last updated
Last updated
The goal of this document is to facilitate the work and minimize the effort of all API users at adidas while protecting their investment and encouraging API First adoption.
These guidelines lay down the foundation for collaboration, stability, and extensibility.
The API Guidelines are split into two main parts:
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 APIs).
The CAPITALIZED words throughout these guidelines have a special meaning:
In the ruleset.md file you can find a digest of API Guidelines rules which you can use to validate your API description documents.
To install Spectral, you will need Node.js and a package manager (npm or yarn).
Once installed, to verify your oas or async file with spectral execute:
In case you have any questions or comments, please utilize the appropriate GitHub collaboration tools, such as issues, pull requests, and discussions.
If you want to contact adidas API Team regarding these guidelines, you can mail us at
api-team@adidas.com
This project is intended to provide the guidelines for design & development of APIs at adidas.
Adidas is not responsible for the usage of this software for different purposes that the ones described in the use cases.
February 2025
© adidas AG
adidas AG publishes this software and accompanied documentation (if any) subject to the terms of the MIT license with the aim of helping the community with our tools and libraries which we think can be also useful for other people. You will find a copy of the MIT license in the root folder of this package. All rights not explicitly granted to you under the MIT license remain the sole and exclusive property of adidas AG.
NOTICE: The software has been designed solely for the purpose of providing API design and development guidelines. The software is NOT designed, tested or verified for productive use whatsoever, nor or for any use related to high-risk environments, such as health care, highly or fully autonomous driving, power plants, or other critical infrastructures or services.
These guidelines are available for online reading at . The source code can be found on .
Refer to for details.
If you are using OpenAPI or AsyncAPI specification as API description format, you can also leverage the adidas-spectral.yaml ruleset to automatically lint your specification compliance using .
For further information open the page.
