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
master
api-guidelines/rest-api-guidelines/core-principles/design-platform.md
DeDiego, JesusJavier f076a89c85 Removed automation mention
2022-04-05 12:22:21 +02:00

731 B
Raw Permalink Blame History

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)