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

Updates SUMMARY.md

Browse Source 
Auto commit by GitBook Editor
This commit is contained in:
apidesigner
2018-06-23 13:12:30 +00:00
parent 4c4b460029
commit edd820388e
6 changed files with 57 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -16,8 +16,8 @@ The API Guidelines are split into two main parts:
* [General Guidelines](/general-guidelines/README.md)
* API type-specific Guidelines
* [REST APIs Guidelines](/rest/introduction.md)
* [Kafka Guidelines](/kafka/introduction.md)
* [REST APIs Guidelines](/rest/README.md)
* [Kafka Guidelines](/kafka/README.md)
The general guidelines section discusses the core principles relevant to any kind of API. The API type-specific section further defines the guidelines specific to a given architectural style or API technique \(such as REST, Kafka or GraphQL API\).

4
SUMMARY.md
View File

@@ -18,7 +18,7 @@
## REST API Guidelines
* [Introduction](rest/introduction.md)
* [Introduction](rest/README.md)
* [Core Principles](rest/core-principles/README.md)
* [OpenAPI Specification](rest/core-principles/openapi-specification.md)
* [API Design Platform](rest/core-principles/apiary.md)
@@ -66,5 +66,5 @@
## Kafka Guidelines
* [Introduction](kafka/introduction.md)
* [Introduction](kafka/README.md)

6
kafka/README.md Normal file
View File

@@ -0,0 +1,6 @@
# ![](/assets/adidas-logo.svg)
# adidas Kafka Guidelines

6
kafka/introduction.md
View File

@@ -1,6 +0,0 @@
# ![](/assets/adidas-logo.svg)
# adidas Kafka Guidelines

47
rest/README.md
View File

@@ -0,0 +1,47 @@
# ![](/assets/adidas-logo.svg)
# adidas REST API Guidelines
The adidas REST API Guidelines defines standards and guidelines for building REST APIs at adidas. **These Guidelines has to be followed in addition to the adidas **[**General API Guidelines.**](/general-guidelines/README.md)
The REST API Guidelines are further split into the following parts:
* **Core Principles**
REST API Guidelines Core Principles defines the rules that **MUST** be followed at throughout the full API lifecycle.
* **Functionality Guidelines**
* [**Protocol level**](https://adidas-group.gitbooks.io/api-guidelines/content/protocol/)
Protocol guidelines define the protocols used within the organization.
* [**Message level**](https://adidas-group.gitbooks.io/api-guidelines/content/message/)
The Message guidelines define the structure and semantics of messages used to exchange information.
* [**Application level**](https://adidas-group.gitbooks.io/api-guidelines/content/application/)
The Application guidelines define the definition and use of application-specific semantics.
* **Quality Guidelines**
Evolution and Execution guidelines define the rules for achieving the desired architectural qualities of systems.
* [**Evolution**](https://adidas-group.gitbooks.io/api-guidelines/content/evolution/)
Evolution qualities governance, such as testability, maintainability, extensibility, and scalability.
* [**Execution**](https://adidas-group.gitbooks.io/api-guidelines/content/execution/)
Execution qualities governance, such as security and usability.
* **Guides**
Guides and materials supporting the REST API Guidelines
* **API Clients**
Section dedicated to consumers of adidas APIs

49
rest/introduction.md
View File

@@ -1,49 +0,0 @@
# ![](/assets/adidas-logo.svg)
# adidas REST API Guidelines
The adidas REST API Guidelines defines standards and guidelines for building REST APIs at adidas.
> NOTE: These Guidelines has to be followed in addition to the General Guidelines.
The REST API Guidelines are further split into the following parts:
* **Core Principles**
REST API Guidelines Core Principles defines the rules that **MUST** be followed at throughout the full API lifecycle.
* **Functionality Guidelines**
* [**Protocol level**](https://adidas-group.gitbooks.io/api-guidelines/content/protocol/)
Protocol guidelines define the protocols used within the organization.
* [**Message level**](https://adidas-group.gitbooks.io/api-guidelines/content/message/)
The Message guidelines define the structure and semantics of messages used to exchange information.
* [**Application level**](https://adidas-group.gitbooks.io/api-guidelines/content/application/)
The Application guidelines define the definition and use of application-specific semantics.
* **Quality Guidelines**
Evolution and Execution guidelines define the rules for achieving the desired architectural qualities of systems.
* [**Evolution**](https://adidas-group.gitbooks.io/api-guidelines/content/evolution/)
Evolution qualities governance, such as testability, maintainability, extensibility, and scalability.
* [**Execution**](https://adidas-group.gitbooks.io/api-guidelines/content/execution/)
Execution qualities governance, such as security and usability.
* **Guides**
Guides and materials supporting the REST API Guidelines
* **API Clients**
Section dedicated to consumers of adidas APIs