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
3435a7406f35639fafad231187bf2f985aa32482
api-guidelines/core-principles/api-first.md
oonovak 3435a7406f a 
a
2017-02-13 14:46:39 +01:00

572 B
Raw Blame History

API First

  1. Development of an API MUST always start with API design.
  2. API design SHOULD be realized following the API design process
  3. An API design MUST be formalized in a form of an API description using Swagger and stored in Apiary.
  4. API description is master of truth, not the API implementation.

FURTHER NOTES: API first approach is crucial when adopting the Microservice architecture.
Describing what API is supposed to do also helps all stakeholders to align and better understand what will be delivered at the end.