Case Studies
The best way to learn how to use AsyncAPI is not only through documentation that usually is focused on recommendations and best practices. It is also good to confront with real-life case studies that explain how people really use AsyncAPI and what are their flows.
Feel free to submit your case study. We have a template for you. For more details read our FAQ.
Adeo owns different brands in retail industry focused on home improvement and DIY markets, like Leroy Merlin.
The HDI brand operates in Germany and internationally, offering life and property/casualty insurance services. They cater to both private individuals and corporate clients, and have been providing industrial insurance since 2016.
Founded in 2012, TransferGo provides international money transfer services with a focus on accessibility, speed, and affordability for migrants. The company operates in over 160 countries and serves millions of customers globally, ensuring fast and reliable cross-border payments.
Adopters
Feel free to submit a pull request with information about how your company uses AsyncAPI. We know that writing an official case study might be time consuming and requires too much internal paper work. Let's make sure we can at least capture a use case that is already a great learning information for the community.
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.
| Company name | Use Case | Resources |
|---|---|---|
| Raiffeisen Bank | 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. | |
| LEGO Group | 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. | |
| LEGO Group | Defining, documenting, and distributing event-driven APIs while ensuring consistency and governance. | |
| Bank of New Zealand | Establishing a decentralized company-wide governance strategy for APIs, providing a self-service platform for publishing APIs and documentation. | |
| Zora Robotics | Documenting public MQTT APIs for IoT products and constructing a developer portal. | |
| Walmart | Managing a centralized API Hub for internal teams, enhancing event discoverability and visibility using AsyncAPI. AsyncAPI facilitates company-wide governance on asynchronous APIs. | |
| eBay | Facilitating partner integration with eBay through asynchronous communication, leveraging public AsyncAPI documents for code generation and rapid integration, while ensuring governance and standardization. | |
| Postman | 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. | |
| Adobe | Providing event documentation to expedite development by generating classes based on message payload information from AsyncAPI documents. | |
| Open University of Catalonia and Prodevelop | 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. | |
| Oracle | Documenting data streaming APIs with AsyncAPI documents for client library generation in various programming languages, reducing development time for applications consuming data. | |
| TransferGo | 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. | |
| Kuehne+Nagel | 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. | |
| Adidas | 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. | |
| Morgan Stanley | Used for sharing Websocket based APIs for discoverability and unified security. | |
| Adeo | 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. | |
| HDI Global SE | 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. | |
| SAP | Using AsyncAPI to deliver company wide event catalog for easier discoverability of events and event-driven APIs. | |
| Lombard Odier | Using AsyncAPI as contract for mocking and testing APIs and documentation. | |
| Siemens AG | Using AsyncAPI to document their ROS2 interfaces. | |
| PagoPA | Using AsyncAPI for documentation purposes to help developers understand event-driven APIs. Using Springwolf project and generate AsyncAPI documents from code. |
Raiffeisen Bank
Use Case:
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.
Resources:
LEGO Group
Use Case:
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.
Resources:
LEGO Group
Use Case:
Defining, documenting, and distributing event-driven APIs while ensuring consistency and governance.
Resources:
Bank of New Zealand
Use Case:
Establishing a decentralized company-wide governance strategy for APIs, providing a self-service platform for publishing APIs and documentation.
Resources:
Zora Robotics
Use Case:
Documenting public MQTT APIs for IoT products and constructing a developer portal.
Resources:
Walmart
Use Case:
Managing a centralized API Hub for internal teams, enhancing event discoverability and visibility using AsyncAPI. AsyncAPI facilitates company-wide governance on asynchronous APIs.
Resources:
eBay
Use Case:
Facilitating partner integration with eBay through asynchronous communication, leveraging public AsyncAPI documents for code generation and rapid integration, while ensuring governance and standardization.
Resources:
Postman
Use Case:
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.
Resources:
Adobe
Use Case:
Providing event documentation to expedite development by generating classes based on message payload information from AsyncAPI documents.
Resources:
Open University of Catalonia and Prodevelop
Use Case:
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.
Resources:
Oracle
Use Case:
Documenting data streaming APIs with AsyncAPI documents for client library generation in various programming languages, reducing development time for applications consuming data.
Resources:
TransferGo
Use Case:
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.
Resources:
Kuehne+Nagel
Use Case:
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.
Resources:
Adidas
Use Case:
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.
Resources:
Morgan Stanley
Use Case:
Used for sharing Websocket based APIs for discoverability and unified security.
Resources:
Adeo
Use Case:
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.
Resources:
HDI Global SE
Use Case:
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.
Resources:
SAP
Use Case:
Using AsyncAPI to deliver company wide event catalog for easier discoverability of events and event-driven APIs.
Resources:
Lombard Odier
Use Case:
Using AsyncAPI as contract for mocking and testing APIs and documentation.
Resources:
PagoPA
Use Case:
Using AsyncAPI for documentation purposes to help developers understand event-driven APIs. Using Springwolf project and generate AsyncAPI documents from code.