You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: "All use cases related to AsyncAPI collectively contribute to most important aspect of software development, which is costs reduction. For example with \"Infrastructure as Code\" instead of enabling costly on-demand topic provisioning in your broker, you can automate it safely using AsyncAPI contracts. Before you provision new topics, you can first validate if it this is not causing duplicates and unnecessary costs increase. Use case like \"Governance and Consistency\" or \"Developer Portal\" significantly contributes to adoption of events infrastructure in consistent way and makes onboarding faster, that directly converts to cost reduction."
2
+
usecases:
3
+
infraascode:
4
+
title: Infrastructure as Code
5
+
description: This makes them a great fit for Infrastructure as Code. DevOps teams can use AsyncAPI contracts to automatically provision topics, assign access rights, and configure brokers. Instead of manual setup, everything is declarative and repeatable.
6
+
inproduction:
7
+
- $ref: '#/data/raiffeisen'
8
+
- $ref: '#/data/kuehne'
9
+
- $ref: '#/data/lego1'
10
+
- $ref: '#/data/postman'
11
+
- $ref: '#/data/newzealand'
12
+
# - $ref: '#/data/schwarz'
13
+
testing:
14
+
title: Testing and Mocking
15
+
description: "You don’t need to wait for producers to deploy before you start building consumers. Once teams agree on the event structure, you can capture it in an AsyncAPI contract and generate mocks directly. This lets developers test consumers against simulated producers, speeding up development and avoiding bottlenecks."
16
+
inproduction:
17
+
- $ref: '#/data/transfergo'
18
+
- $ref: '#/data/lombard'
19
+
docs:
20
+
title: Developer Portal and Discoverability
21
+
description: Generate documentation and share across entire organization which events exist, who produces them, who consumes them, and how traffic flows. This makes onboarding easier and promotes cross-team visibility. Identify what consumers will be affected by event changes introduced by producers.
22
+
inproduction:
23
+
- $ref: '#/data/lego1'
24
+
- $ref: '#/data/transfergo'
25
+
- $ref: '#/data/newzealand'
26
+
- $ref: '#/data/zora'
27
+
- $ref: '#/data/walmart'
28
+
- $ref: '#/data/hdi'
29
+
- $ref: '#/data/adidas'
30
+
- $ref: '#/data/sap'
31
+
- $ref: '#/data/ebay'
32
+
- $ref: '#/data/adeo'
33
+
governance:
34
+
title: Governance and Consistency
35
+
description: Assure consistency across your event ecosystem. You can validate contracts to ensure topic names follow organizational standards, check that no sensitive information is exposed, and apply custom rules through linting. This builds governance into the development lifecycle without slowing teams down.
36
+
inproduction:
37
+
- $ref: '#/data/lego2'
38
+
- $ref: '#/data/kuehne'
39
+
- $ref: '#/data/newzealand'
40
+
- $ref: '#/data/walmart'
41
+
- $ref: '#/data/ebay'
42
+
- $ref: '#/data/universitycatalonia'
43
+
selfservice:
44
+
title: Self-Service
45
+
description: "Because AsyncAPI is machine-readable, it’s perfect for building self-service platforms. Teams can submit their contracts to a central service, which automatically validates schemas, publishes them to a shared registry, and provisions broker resources. This enables faster time-to-production while keeping standards and compliance intact."
46
+
inproduction:
47
+
- $ref: '#/data/lego1'
48
+
- $ref: '#/data/walmart'
49
+
- $ref: '#/data/newzealand'
50
+
codegen:
51
+
title: Code Generation
52
+
description: AsyncAPI helps eliminate boilerplate code. You can start by generating strongly typed models from message schemas and go further by producing client libraries or even SDKs. This accelerates development, reduces human error, and ensures producers and consumers always stay aligned with the contract.
53
+
inproduction:
54
+
- $ref: '#/data/raiffeisen'
55
+
- $ref: '#/data/oracle'
56
+
- $ref: '#/data/adobe'
57
+
- $ref: '#/data/adidas'
58
+
- $ref: '#/data/universitycatalonia'
59
+
- $ref: '#/data/transfergo'
60
+
extensibility:
61
+
title: Extensibility - Quality of Service Monitoring
62
+
description: AsyncAPI supports extensions, so you can enrich contracts with operational requirements like SLA or QoS details. For example, an IoT device might declare its expected latency or throughput. Monitoring tools can read these extensions, track service quality, and raise alerts when metrics fall below agreed levels.
63
+
inproduction:
64
+
- $ref: '#/data/universitycatalonia'
65
+
data:
66
+
raiffeisen:
67
+
name: Raiffeisen Bank
68
+
description: Implementing a Continuous Integration and Continuous Delivery (CI/CD) pipeline utilizing GitOps principles to deploy a topology constructed on AsyncAPI definitions using a Kubernetes operator to an Apache Pulsar cluster.
69
+
resources:
70
+
- type: Video
71
+
url: https://www.youtube.com/watch?v=_MwzLZMwFN8
72
+
lego1:
73
+
name: LEGO Group
74
+
description: Managing brokers, where developers abstain from direct access to the management console and instead upload AsyncAPI documents to a self-service API, which provisions access and topics specified in the documents.
75
+
resources:
76
+
- type: Video
77
+
url: https://www.youtube.com/watch?v=m8I0fYjx6Cc
78
+
lego2:
79
+
name: LEGO Group
80
+
description: Defining, documenting, and distributing event-driven APIs while ensuring consistency and governance.
81
+
resources:
82
+
- type: Video
83
+
url: https://www.youtube.com/watch?v=qjarcJQVLOg
84
+
newzealand:
85
+
name: Bank of New Zealand
86
+
description: Establishing a decentralized company-wide governance strategy for APIs, providing a self-service platform for publishing APIs and documentation.
description: Documenting public MQTT APIs for IoT products and constructing a developer portal.
93
+
resources:
94
+
- type: Video
95
+
url: https://www.youtube.com/watch?v=yjHgT0n2BtA
96
+
walmart:
97
+
name: Walmart
98
+
description: Managing a centralized API Hub for internal teams, enhancing event discoverability and visibility using AsyncAPI. AsyncAPI facilitates company-wide governance on asynchronous APIs.
99
+
resources:
100
+
- type: Video
101
+
url: https://www.youtube.com/watch?v=SxTpGRaNIPo
102
+
ebay:
103
+
name: eBay
104
+
description: Facilitating partner integration with eBay through asynchronous communication, leveraging public AsyncAPI documents for code generation and rapid integration, while ensuring governance and standardization.
105
+
resources:
106
+
- type: Video
107
+
url: https://www.youtube.com/watch?v=SxTpGRaNIPo
108
+
postman:
109
+
name: Postman
110
+
description: Enhancing discoverability of information about system events by building a tool called Synapse for provisioning entire event-based infrastructure, with AsyncAPI documents as the source of truth.
111
+
resources:
112
+
- type: Video
113
+
url: https://www.youtube.com/watch?v=0_7QZyKLPoE
114
+
adobe:
115
+
name: Adobe
116
+
description: Providing event documentation to expedite development by generating classes based on message payload information from AsyncAPI documents.
description: Enabling monitoring of ports through a design-first approach, utilizing UML class diagrams to design the entire infrastructure. UML diagrams are source of truth for generated AsyncAPI documents that later are used for models and clients generation. These documents are extended with additional SLA properties to specify runtime quality of service requirements, facilitating real-time monitoring.
123
+
resources:
124
+
- type: Video
125
+
url: https://www.youtube.com/watch?v=m4KS6FSeTT4
126
+
oracle:
127
+
name: Oracle
128
+
description: Documenting data streaming APIs with AsyncAPI documents for client library generation in various programming languages, reducing development time for applications consuming data.
129
+
resources:
130
+
- type: Video
131
+
url: https://www.youtube.com/watch?v=CGLlxYy66LY
132
+
transfergo:
133
+
name: TransferGo
134
+
description: TransferGo uses the AsyncAPI specification as the essential, standardized blueprint for their event-driven microservices, enabling automated documentation (Event Catalog), continuous validation, and reliable contract testing (Microcks) to ensure clarity and trust across their system.
description: Implementing a GitOps-based pipeline to enable self-service management of Kafka infrastructure, including access control management. Automation of AsyncAPI document governance ensures consistency in the infrastructure at the pull request level.
description: AsyncAPI is a standard for defining asynchronous APIs using Apache Kafka. AsyncAPI governed under official guidelines. AsyncAPI is promoted to be used for documentation and code generation.
description: Document the API of the product, so its users know how it works and how to use it. AsyncAPI was selected as the standard that allows you to generate documentation from a machine-readable document that describes the API. The goal was to document API in a standardized way, so other internal products could follow to unify how APIs are documented across the company.
description: The AsyncAPI documents are used for documentation purposes by the platform team. It provides a comprehensive overview of the asynchronous communication in our system, including the available topics and the structure of the messages.
description: Using AsyncAPI to document their ROS2 interfaces.
189
+
resources:
190
+
- type: Code
191
+
url: https://github.com/siemens/rosita
192
+
pagopa:
193
+
name: PagoPA
194
+
description: Using AsyncAPI for documentation purposes to help developers understand event-driven APIs. Using Springwolf project and generate AsyncAPI documents from code.
0 commit comments