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

GITBOOK-2: No subject

Browse Source
This commit is contained in:
Cesareo
2024-05-10 09:32:22 +00:00
committed by gitbook-bot
parent 2a0df79e63
commit b1e72ce21d
70 changed files with 529 additions and 676 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
asynchronous-api-guidelines/01_introduction/a_introduction.md
View File

@@ -1,22 +1,10 @@
# adidas Asynchronous API guidelines
## Introduction
### About guidelines
In the scope of a company, organization or team, the document known as guidelines is a set of best practices or hints provided by a group of subject matter experts in that particular technology. The most important aspects of it:
- Help to create a standardized way of completing specific tasks, making outcome more predictable and alike
- Help to identify do's and dont's with regards to a specific technology or tool
- Help to avoid gotchas or problems related with company specifics
- Gather the knowledge of several Subject Matter Experts and prevent others for falling in frequent caveats or mistakes
**Note** In any case, the content in the guidelines should be taken as recommendations, not something that needs to be done in a mandatory way.
# Introduction
## adidas Asynchronous API Guidelines
Adidas Asynchronous API Guidelines define standards and guidelines for building Asynchronous APIs at adidas. **These Guidelines have to be followed in addition to the Adidas** [**General API Guidelines.**](../../general-guidelines/general-guidelines.md)
The Asynchronous API Guidelines are further split into the following parts:
* **Core Asynchronous Principles**
* **Kafka Asynchronous Guidelines**