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
62601ea5d26f9d51427605f4885cb951d0daf0e4
api-guidelines/rest-api-guidelines/core-principles/design-platform.md
Zdenek Nemec 62601ea5d2 Replace apiary with swaggerhub
2020-01-17 08:14:30 +01:00

913 B
Raw Blame History

API Design Platform

  1. SwaggerHub is the primary platform supporting API first approach. SwaggerHub SHOULD 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)

NOTE: The synchronization between the version control system and adidas API Design platform should be automated (e.g. using CI/CD framework or the Design Platform capabilities).