Skip to content

Files

Latest commit

f076a89 · Apr 5, 2022

History

History
9 lines (6 loc) · 731 Bytes

design-platform.md

File metadata and controls

9 lines (6 loc) · 731 Bytes

API Design Platform

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

NOTE: SwaggerHub supports API-first approach in multiple ways:
For example, it 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)