Skip to content

Latest commit

 

History

History
12 lines (9 loc) · 833 Bytes

apiary.md

File metadata and controls

12 lines (9 loc) · 833 Bytes

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.