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
740980ea4338fe5c7823f498aa67c8bed2274a71
api-guidelines/rest-api-guidelines/core-principles/apiary.md
apidesigner 2f6bfab524 GitBook: [master] 12 pages modified
2018-07-23 08:09:03 +00:00

833 B
Raw Blame History

API Design Platform

  1. Apiary is the primary platform supporting API first approach. Apiary MUST be used during API Design.
  2. Every API description MUST be stored in Apiary under the ADIDAS team.
  3. Apiary MUST be the single source of truth to learn about existing APIs within the organization.

NOTE: Apiary supports API-first approach in multiple ways:
a. Validates API description for correctness and automatically generates API documentation to drive the discussion between stakeholders. (No more emails with API description flying between stakeholders)

NOTE: The synchronization between the version control system and adidas API Description platform
should be automated using CI/CD framework.