mirror of
https://github.com/adidas/api-guidelines.git
synced 2025-10-25 15:19:19 +00:00
42 lines
1.5 KiB
Markdown
42 lines
1.5 KiB
Markdown
# Introduction
|
|
|
|
## 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/general-guidelines.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**](protocol/)\*\*\*\*
|
|
|
|
Protocol guidelines define the protocols used within the organization.
|
|
|
|
* \*\*\*\*[**Message level**](message/)\*\*\*\*
|
|
|
|
The Message guidelines define the structure and semantics of messages used to exchange information.
|
|
|
|
* \*\*\*\*[**Application level**](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**](evolution/)\*\*\*\*
|
|
|
|
Evolution qualities governance, such as testability, maintainability, extensibility, and scalability.
|
|
|
|
* \*\*\*\*[**Execution**](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
|
|
|