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/kafka-asynchronous-guidelines/a_introduction/README.md Normal file
View File

@@ -0,0 +1,24 @@
# Introduction
This section is specific to the definition of API specs with [AsyncAPI](https://www.asyncapi.com/) for Kafka protocol.
Also, take into account that across the section there will be multiple references to this [AsyncAPI reference specification](https://design.api.3stripes.io/apis/adidas/asyncapi-adoption-initiative/1.0.0) which is publicly available for reference. 
#### Kafka to AsyncAPI concept mapping
| Kafka Concept | AsyncAPI Concept |
| ------------- | ---------------- |
| broker | server |
| topic | channel |
| consumer | subscriber |
| producer | publisher |
#### First level items in AsyncAPI structure
| Element | Meaning |
| ---------- | -------------------------------------------------------------------------- |
| asyncapi | Specifies the AsyncAPI specification version |
| info | Provides metadata about the API such as the version, title and description |
| servers | Describes servers where the API is available |
| channels | Defines the channels through which messages are received/published |
| components | Reusable elements to be references across the spec |