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

a

Browse Source 
a
This commit is contained in:
oonovak
2017-02-13 14:46:39 +01:00
parent b7b4c99d21
commit 3435a7406f
1 changed files with 7 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,12 +1,11 @@
# API First
1. Development of an API MUST always start with API design.
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.
1. API design SHOULD be realized following the **API design process**
> NOTE: API first approach is critical for adopting the Microservice architecture.
API design needs to be agreed with stakeholders
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.
Describing what API is supposed to do also helps all stakeholders to align and better understand what will be delivered at the end.