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

apiary

Browse Source 
apiary
This commit is contained in:
oonovak
2017-02-13 15:42:37 +01:00
parent dfee6539bd
commit f8e0f3b1e4
2 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
SUMMARY.md
View File

@@ -4,7 +4,7 @@
* [Core Principles](core-principles/README.md)
* [API First](core-principles/api-first.md)
* [OpenAPI Specification](core-principles/openapi-specification.md)
* [Apiary](core-principles/apiary.md)
* [API design platform](core-principles/apiary.md)
* [Version Control System](core-principles/version-control-system.md)
* [Contract](core-principles/contract.md)
* [Testing](core-principles/testing.md)

10
core-principles/apiary.md
View File

@@ -1,3 +1,9 @@
# Apiary
Every API description MUST be stored in [Apiary](https://apiary.io/) under the ADIDAS GROUP team. Apiary MUST be the **single source of truth** to learn about existing APIs within the organization.
# API design platform - Apiary
1. [Apiary](https://apiary.io/) is the primary platform supporting [API first approach](./api-first.md). Apiary MUST be used during API Design.
1. Every API description MUST be stored in [Apiary](https://apiary.io/) under the ADIDAS GROUP team.
1. Apiary MUST be the **single source of truth** to learn about existing APIs within the organization.
> 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.