diff --git a/SUMMARY.md b/SUMMARY.md index 43e9eae..5b48e12 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -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) diff --git a/core-principles/apiary.md b/core-principles/apiary.md index e3290a8..6b0430c 100644 --- a/core-principles/apiary.md +++ b/core-principles/apiary.md @@ -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.