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
c14af2bba2b1f6bdff71ab69181521bb1a396aa7
api-guidelines/core-principles/api-first.md
oonovak c14af2bba2 Updates core-principles/api-first.md 
Auto commit by GitBook Editor
2017-02-13 16:44:14 +00:00

1.2 KiB
Raw Blame History

API First

Everyone MUST follow the API first principle.

API first principle is extension of Contract first architecture principle. Therefore development of an API MUST always start with API design without any upfront coding activities. An API design MUST be formalized in a form of an API description using Open API Specification and stored in adidas API description platform and agreed by all stakeholders.

Clearly describing what API is supposed to do before coding it, helps to facilitate discussion between stakeholders and allows to receive feedback in early stage of the API development process. It also helps to establish governance on API's to check that certain quality is met and API guidelines are being followed.

API description is master of truth, not the API implementation. API implementation MUST always be compliant to respective API description which represent the Contract between API and it's consumer.

NOTE:

  • It's not acceptable that API is developed first and later on described in some proprietary format.
  • It's not acceptable that API implementation doesn't implement it's description.