mirror of
https://github.com/adidas/api-guidelines.git
synced 2025-10-25 15:19:19 +00:00
11 lines
761 B
Markdown
11 lines
761 B
Markdown
# OpenAPI Specification
|
|
|
|
Every API **MUST** be described using an API description format. The API description format used **MUST** be the [OpenAPI Specification \(formerly known as Swagger Specification\) version 2.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md) OR the [OpenAPI Specification \(formerly known as Swagger Specification\) version 3.0.x](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md).
|
|
|
|
Every API description **MUST** be published in adidas [API design platform](design-platform.md) and it **SHOULD** be stored in version control system \(Bitbucket, GitHub\) in the same repository as the API implementation.
|
|
|
|
## Language
|
|
|
|
The API description **MUST** be written in **American English**.
|
|
|