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

API first

Browse Source 
API first
This commit is contained in:
oonovak
2017-02-13 14:58:24 +01:00
parent 3435a7406f
commit dfee6539bd
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
core-principles/api-first.md
View File

@@ -1,11 +1,12 @@
# API First
1. Development of an API MUST always start with API design.
1. API design SHOULD be realized following the **API design process**
1. API design SHOULD be realized following the **API design process**.
1. An API design MUST be formalized in a form of an API description using **Swagger** and stored in [Apiary](./apiary.md).
1. **API description is master of truth, not the API implementation.**
> FURTHER NOTES: API first approach is crucial when adopting the Microservice architecture.
> NOTE: 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.
It's not acceptable that API is developed first and later on described in some proprietary format.