Comment on page
adidas API Guidelines
Guidelines for the API design and development at adidas
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 adoption.
These guidelines lay down the foundation for collaboration, stability, and extensibility.
The API Guidelines are split into two main parts:
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:
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT","SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" inthis document are to be interpreted as described in RFC2119.
ruleset.mdfile you can find a digest of API Guidelines rules which you can validating your API description documents with. If you are using OpenAPI Specification as the API description format you can also leverage the
.spectral.yamlruleset to automatically verify your specification compliance using Spectral.
To install Spectral you will need Node.js and a package manager (npm or yarn).
Note: The version used with the spectal specifictions was 5.3.0
Once installed, to verify your OAS file with spectral execute
spectral lint <oas-file> -r <adidas-api-guidelines-folder>/.spectral.yamlwhere
<adidas-api-guidelines-folder>/.spectral.yamlindicated the location
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.
© 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.