Mirrors/api-guidelines
1
0
Fork 0
mirror of https://github.com/adidas/api-guidelines.git synced 2025-10-25 15:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
0cc71187cf854d714047e9d1fb65daa3e74048ed
api-guidelines/core-principles/openapi-specification.md
oonovak 37a3e8f85a Updates core-principles/openapi-specification.md 
Auto commit by GitBook Editor
2017-02-13 16:48:19 +00:00

782 B
Raw Blame History

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. Every API description MUST be:

  • published in adidas API design platform
  • stored in version control system (Bitbucket, GitHub) in the same repository as the API implementation.
  • accessible via endpoint through GET operation. To be discussed

NOTE: Synchronization between the version control system and adidas API description platform should be automated using CICD framework.

Language

The API description MUST be written in American English.