llms.txt
Compare with other sites' llms.txt files →# AsyncAPI
> Open source tools to easily build and maintain your event-driven architecture. All powered by the AsyncAPI specification, the industry standard for defining asynchronous APIs.
How to use: start here, then fetch only the `.md` links you need.
Append `.md` to any docs or blog URL.
Core docs concatenated: https://www.asyncapi.com/llms-full.txt
## Welcome
- [Welcome](https://www.asyncapi.com/docs.md): Welcome to AsyncAPI Docs!
## Concepts
- [Overview](https://www.asyncapi.com/docs/concepts.md): Concepts Welcome to AsyncAPI Concepts!
- [Server](https://www.asyncapi.com/docs/concepts/server.md): What is a server?
- [Producer](https://www.asyncapi.com/docs/concepts/producer.md): What is a Producer?
- [Consumer](https://www.asyncapi.com/docs/concepts/consumer.md): What is a consumer?
- [Channel](https://www.asyncapi.com/docs/concepts/channel.md): What is a channel?
- [Application](https://www.asyncapi.com/docs/concepts/application.md): What is an application?
- [Protocol](https://www.asyncapi.com/docs/concepts/protocol.md): What is a protocol?
- [Message](https://www.asyncapi.com/docs/concepts/message.md): What is a message?
- [Introduction](https://www.asyncapi.com/docs/concepts/asyncapi-document.md): The AsyncAPI specification defines fields for describing an application's API in an AsyncAPI document.
- [AsyncAPI document structure](https://www.asyncapi.com/docs/concepts/asyncapi-document/structure.md): An AsyncAPI document structure must follow a specific format defined by the AsyncAPI specification.
- [Tags](https://www.asyncapi.com/docs/concepts/asyncapi-document/tags.md): tags in AsyncAPI document A tag is a label or category that groups related entities in an event-driven system.
- [Adding channels](https://www.asyncapi.com/docs/concepts/asyncapi-document/adding-channels.md): Incorporating channels in the AsyncAPI document facilitates message organization and categorization, streamlining message routing to suitable consumers.
- [Parameters in channel address](https://www.asyncapi.com/docs/concepts/asyncapi-document/dynamic-channel-address.md): In the context of channel addresses within AsyncAPI documents, parameters play a crucial role in defining the dynamic components of an address.
- [Adding operations](https://www.asyncapi.com/docs/concepts/asyncapi-document/adding-operations.md): In a messaging system, 'operations' are how messages are sent and received between participants or components.
- [Operation security](https://www.asyncapi.com/docs/concepts/asyncapi-document/securing-operations.md): The server security concept in AsyncAPI means that the security settings specified at the server level automatically apply to all operations across all channels.
- [Adding messages](https://www.asyncapi.com/docs/concepts/asyncapi-document/adding-messages.md): In an AsyncAPI document, adding messages mainly means setting up channels and operations.
- [Reusability with traits](https://www.asyncapi.com/docs/concepts/asyncapi-document/reusability-with-traits.md): Traits work only with the operations and messages fields.
- [Server security](https://www.asyncapi.com/docs/concepts/asyncapi-document/server-security.md): Server security refers to the measures and practices implemented to protect servers from unauthorized access, data breaches, and other security threats.
- [Adding reply info](https://www.asyncapi.com/docs/concepts/asyncapi-document/reply-info.md): Request/Reply is a communication pattern where one entity, the 'requestor,' sends a message to another, the 'replier', and waits for a response.
- [Extending specification](https://www.asyncapi.com/docs/concepts/asyncapi-document/extending-specification.md): Extending the AsyncAPI specification allows you to include specific information for your domain or use case that's not currently supported by the original specification or the p...
- [Adding bindings](https://www.asyncapi.com/docs/concepts/asyncapi-document/adding-bindings.md): The following diagram highlights the sections where bindings can be implemented: graph TD A[AsyncAPI Document] --> B((Serv
- [Payload schema](https://www.asyncapi.com/docs/concepts/asyncapi-document/define-payload.md): The payload schema sets the format, data types, and properties of a message.
- [Server variables](https://www.asyncapi.com/docs/concepts/asyncapi-document/variable-url.md): The server's URL consists of the host and pathname fields.
- [Reusable parts](https://www.asyncapi.com/docs/concepts/asyncapi-document/reusable-parts.md): Reusable parts in AsyncAPI provide flexibility, modularity, and code reusability.
- [Add servers](https://www.asyncapi.com/docs/concepts/asyncapi-document/add-server.md): A server often acts as a message broker, managing communication between producers and consumers.
## Tutorials
- [Overview](https://www.asyncapi.com/docs/tutorials.md): Tutorials: Learn how AsyncAPI works Welcome to AsyncAPI Tutorials!
- [Introduction](https://www.asyncapi.com/docs/tutorials/getting-started.md): AsyncAPI is an open source initiative that seeks to improve the current state of Event-Driven Architectures (EDA).
- [Event-Driven Architectures](https://www.asyncapi.com/docs/tutorials/getting-started/event-driven-architectures.md): Many developers, architects, and product managers have used REST APIs and are familiar with the synchronous communication paradigm.
- [Coming from OpenAPI](https://www.asyncapi.com/docs/tutorials/getting-started/coming-from-openapi.md): If you're coming from OpenAPI, you must know that AsyncAPI started as an adaptation of the OpenAPI specification.
- [Hello world](https://www.asyncapi.com/docs/tutorials/getting-started/hello-world.md): Let's define an application that's capable of receiving a "hello {name}" message: Let's get into the details of this sample AsyncAPI document: The first line of the specificatio...
- [Request/reply pattern](https://www.asyncapi.com/docs/tutorials/getting-started/request-reply.md): In this tutorial, you'll learn how to implement the request/reply pattern in an AsyncAPI document using a straightforward ping-pong example.
- [AsyncAPI documents](https://www.asyncapi.com/docs/tutorials/getting-started/asyncapi-documents.md): An AsyncAPI document is a file that defines and annotates the different components of a specific Event-Driven API.
- [Servers](https://www.asyncapi.com/docs/tutorials/getting-started/servers.md): In the previous lesson, you learned how to create the definition of a simple Hello World application.
- [Adding security](https://www.asyncapi.com/docs/tutorials/getting-started/security.md): In production environments, your API may have to access a message broker that's protected by some auth mechanisms.
- [Create AsyncAPI document](https://www.asyncapi.com/docs/tutorials/create-asyncapi-document.md): Introduction In this tutorial, you'll learn how to create an AsyncAPI document based on a sample real-world use case.
- [Generate code](https://www.asyncapi.com/docs/tutorials/generate-code.md): Introduction In this tutorial, you'll learn how to generate an application that uses the Glee framework.
- [Validate AsyncAPI document with Studio](https://www.asyncapi.com/docs/tutorials/studio-document-validation.md): Introduction In this tutorial, you'll learn how to validate AsyncAPI documents using the AsyncAPI Studio tool.
- [Message validation in runtime](https://www.asyncapi.com/docs/tutorials/message-validation.md): Introduction In this tutorial, you'll learn how to validate messages (events) that are sent to your AsyncAPI application.
- [Streetlights - Interactive](https://www.asyncapi.com/docs/tutorials/streetlights-interactive.md): Check out the Streetlights interactive tutorial; we plan to have more docs written this way!
- [Create an AsyncAPI document for a Slackbot with WebSocket](https://www.asyncapi.com/docs/tutorials/websocket.md): Introduction In this tutorial, you will learn how to write an AsyncAPI document designed for a Slack application that operates in Socket Mode.
- [Implement Request/Reply in an AsyncAPI document for a Slack app](https://www.asyncapi.com/docs/tutorials/websocket/websocket-request-reply.md): Introduction In the Create an AsyncAPI Document for a Slackbot with WebSockets tutorial, you learned how to write an AsyncAPI document for a Slackbot Heart-Counter that actively...
- [Create AsyncAPI document for applications consuming from Kafka](https://www.asyncapi.com/docs/tutorials/kafka.md): Introduction In this tutorial, you will create a schema document for Kafka Messages using AsyncAPI.
- [Describe Kafka message payload using Avro Schema](https://www.asyncapi.com/docs/tutorials/kafka/configure-kafka-avro.md): Introduction The previous tutorial on creating an AsyncAPI document for applications consuming from Kafka taught you about writing an AsyncAPI document for Kafka messages using...
- [Managing schemas using Schema Registry](https://www.asyncapi.com/docs/tutorials/kafka/managing-schemas-using-schema-registry.md): Introduction In the previous Kafka and Avro configuration tutorial, you learned how to add Apache Avro schemas to your AsyncAPI document.
- [Kafka bindings](https://www.asyncapi.com/docs/tutorials/kafka/bindings-with-kafka.md): Introduction You learned how to manage schemas with a schema registry in the previous tutorial.
## Tools
- [Overview](https://www.asyncapi.com/docs/tools.md): Tools: the AsyncAPI tools ecosystem Welcome to AsyncAPI Tools!
- [Introduction](https://www.asyncapi.com/docs/tools/generator.md): The AsyncAPI generator is a tool that generates anything you want using the AsyncAPI Document and Template that are supplied as inputs to the AsyncAPI CLI.
- [Installation guide](https://www.asyncapi.com/docs/tools/generator/installation-guide.md): You can use the generator library to generate whatever you want in your event-driven architecture apps.
- [Usage](https://www.asyncapi.com/docs/tools/generator/usage.md): There are two ways to use the generator: AsyncAPI CLI Generator library AsyncAPI CLI asyncapi generate fromTemplate ASYNCAPI TEMPLATE Generates whatever you want using templates...
- [AsyncAPI document](https://www.asyncapi.com/docs/tools/generator/asyncapi-document.md): The AsyncAPI document defines a standard, protocol-agnostic interface that describes message-based or event-driven APIs.
- [Template](https://www.asyncapi.com/docs/tools/generator/template.md): Template A template is a project that specifies the generation process output by using the AsyncAPI Generator (generator) and an AsyncAPI document.
- [Baked-in Templates](https://www.asyncapi.com/docs/tools/generator/baked-in-templates.md): This is a new concept introduced in generator version 2.8.
- [Parser](https://www.asyncapi.com/docs/tools/generator/parser.md): Parser The AsyncAPI Parser is a package used to parse and validate the AsyncAPI documents in your Node.js or browser application.
- [Generator version vs template version](https://www.asyncapi.com/docs/tools/generator/versioning.md): The generator tool generates whatever you want, as long as it can be defined in a template based on the AsyncAPI document.
- [Library API](https://www.asyncapi.com/docs/tools/generator/api.md): Reference API documentation for AsyncAPI Generator library.
- [Reusable Components API](https://www.asyncapi.com/docs/tools/generator/api_components.md): Components CloseConnection ⇒ JSX.Element Renders a WebSocket close connection method with optional pre- and post-execution logic.
- [Template development](https://www.asyncapi.com/docs/tools/generator/template-development.md): Note It is advised against attempting to manually template types and models from scratch using the AsyncAPI templating engines such as the React render engine.
- [Configuration file](https://www.asyncapi.com/docs/tools/generator/configuration-file.md): You can configure your AsyncAPI Generator template using either a dedicated .ageneratorrc YAML file or through the generator property in your package.json file.
- [Template context](https://www.asyncapi.com/docs/tools/generator/template-context.md): While using the generator tool, you may want dynamic values populated to your templates and rendered in the output.
- [React render engine](https://www.asyncapi.com/docs/tools/generator/react-render-engine.md): React is the only render engine supported by the AsyncAPI generator.
- [Hooks](https://www.asyncapi.com/docs/tools/generator/hooks.md): Hooks are functions called by the generator on a specific moment in the generation process.
- [File templates](https://www.asyncapi.com/docs/tools/generator/file-templates.md): Generating files with the React render engine The React render engine allows for a more generic way to render multiple files by returning an array of File components in the rend...
- [TypeScript support](https://www.asyncapi.com/docs/tools/generator/typescript-support.md): The AsyncAPI generator has TypeScript support for hooks.
- [Special file names](https://www.asyncapi.com/docs/tools/generator/special-file-names.md): We use NPM behind the scenes to download and install the templates.
- [Creating a template - Python](https://www.asyncapi.com/docs/tools/generator/generator-template.md): This tutorial teaches you how to create a simple generator template using a Python MQTT client.
- [Using private templates](https://www.asyncapi.com/docs/tools/generator/using-private-template.md): Generator allows fetching the template from private repositories like Verdaccio, Nexus, npm, etc.
- [Creating a template - Java](https://www.asyncapi.com/docs/tools/generator/generator-template-java.md): This tutorial teaches you how to create a simple generator template using a Java MQTT client.
- [Adding models generation in template](https://www.asyncapi.com/docs/tools/generator/model-generation.md): This guide will walk you through the process of enabling models/types generation in a template by using Modelina.
- [Community - Contributing](https://www.asyncapi.com/docs/tools/generator/contributing.md): We love your input!
- [Community - Development setup](https://www.asyncapi.com/docs/tools/generator/development-setup.md): This guide helps you set up the generator locally and run it.
- [Community - Testing](https://www.asyncapi.com/docs/tools/generator/development-testing.md): How to run and add tests for the generator.
- [Community - Release process](https://www.asyncapi.com/docs/tools/generator/release-process.md): This guide details how releases are handled for the generator packages.
- [Community - AI usage policy](https://www.asyncapi.com/docs/tools/generator/ai-policy.md): This policy governs the use of generative AI and AI-assisted tooling (LLMs, coding agents, autocomplete assistants, and similar) when contributing to this repository.
- [Community - AI tooling](https://www.asyncapi.com/docs/tools/generator/ai-tooling.md): This project uses automated AI tools to assist with code review and to answer questions on pull requests and issues.
- [Introduction](https://www.asyncapi.com/docs/tools/cli.md): The AsyncAPI CLI is a command-line tool that provides a set of commands for working with AsyncAPI documents.
- [Installation guide](https://www.asyncapi.com/docs/tools/cli/installation.md): Node and npm To use the AsyncAPI CLI tool, you must install NPM and Node.js version 16 or higher.
- [Auto-complete setup](https://www.asyncapi.com/docs/tools/cli/autocompleteEnabled.md): AsyncAPI CLI Autocomplete Setup This guide provides steps to enable autocomplete for the AsyncAPI CLI.
- [CLI Architecture](https://www.asyncapi.com/docs/tools/cli/architecture.md): CLI Architecture Overview The AsyncAPI CLI is built with oclif and provides both command-line operations and a REST API server for working with AsyncAPI specifications.
- [Usage](https://www.asyncapi.com/docs/tools/cli/usage.md): {/* This file is automatically generated from updateUsageDocs.js script.
- [Contributing via Pull Requests](https://www.asyncapi.com/docs/tools/cli/contributing-prs.md): Contributing via Pull Requests Getting Started Open an issue first (unless it's a trivial fix) Set up environment — Follow DEVELOPMENT.md Create a branch — Use prefixes: feat/,...
- [GitHub Action for CLI](https://www.asyncapi.com/docs/tools/cli/github-action.md): This action exposes the AsyncAPI CLI.
- [Context concept](https://www.asyncapi.com/docs/tools/cli/context.md): Overview AsyncAPI CLI provides functionality called context.
- [Debugging & Testing Guide](https://www.asyncapi.com/docs/tools/cli/debugging-testing.md): Debugging & Testing Guide This guide provides step-by-step instructions for debugging and testing the AsyncAPI CLI.
- [Metrics Collection](https://www.asyncapi.com/docs/tools/cli/metrics_collection.md): Metrics collection guideline AsyncAPI anonymously tracks command executions to improve the specification and tools, ensuring no sensitive data reaches our servers.
## Guides
- [Overview](https://www.asyncapi.com/docs/guides.md): Guides: Teaches AsyncAPI's capabilities at a high level Welcome to AsyncAPI Guides!
- [Validate AsyncAPI documents](https://www.asyncapi.com/docs/guides/validate.md): Introduction In this guide, you'll learn multiple ways to validate AsyncAPI documents.
- [Message validation](https://www.asyncapi.com/docs/guides/message-validation.md): Introduction This guide explains different concepts of validating messages in event-driven communication.
## Reference
- [Overview](https://www.asyncapi.com/docs/reference.md): Reference: AsyncAPI Specification Welcome to AsyncAPI Reference!
- [3.1.0](https://www.asyncapi.com/docs/reference/specification/v3.1.0.md): AsyncAPI Specification Attribution Part of this content has been taken from the great work done by the folks at the OpenAPI Initiative.
- [3.1.0 - Explorer](https://www.asyncapi.com/docs/reference/specification/v3.1.0-explorer.md)
- [3.0.0](https://www.asyncapi.com/docs/reference/specification/v3.0.0.md): AsyncAPI Specification Attribution Part of this content has been taken from the great work done by the folks at the OpenAPI Initiative.
- [3.0.0 - Explorer](https://www.asyncapi.com/docs/reference/specification/v3.0.0-explorer.md)
- [2.x](https://www.asyncapi.com/docs/reference/specification/v2.x.md): To read about previous versions of AsyncAPI specification go to: https://v2.asyncapi.com/docs/reference
- [Overview](https://www.asyncapi.com/docs/reference/extensions.md): What's an extension?
- [linkedin](https://www.asyncapi.com/docs/reference/extensions/linkedin.md): Linkedin Extension This document defines how to use linkedin extension in AsyncAPI documents.
- [x](https://www.asyncapi.com/docs/reference/extensions/x.md): Twitter/X Extension This document defines how to use x extension in AsyncAPI documents.
- [amqp](https://www.asyncapi.com/docs/reference/bindings/amqp.md): AMQP 0-9-1 Bindings This document defines how to describe AMQP-specific information on AsyncAPI.
- [amqp1](https://www.asyncapi.com/docs/reference/bindings/amqp1.md): AMQP 1.0 Bindings This document defines how to describe AMQP 1.0-specific information on AsyncAPI.
- [anypointmq](https://www.asyncapi.com/docs/reference/bindings/anypointmq.md): Anypoint MQ Bindings This document defines how to describe Anypoint MQ-specific information in AsyncAPI documents.
- [googlepubsub](https://www.asyncapi.com/docs/reference/bindings/googlepubsub.md): Google Cloud Pub/Sub Bindings This document defines how to describe Google Cloud Pub/Sub specific information with AsyncAPI.
- [http](https://www.asyncapi.com/docs/reference/bindings/http.md): HTTP Bindings This document defines how to describe HTTP-specific information on AsyncAPI.
- [Overview](https://www.asyncapi.com/docs/reference/bindings.md): Overview Usage in an AsyncAPI document To learn how to add bindings to your AsyncAPI document, read Adding bindings conce
- [ibmmq](https://www.asyncapi.com/docs/reference/bindings/ibmmq.md): IBM MQ Bindings This document defines how to describe IBM MQ specific information with AsyncAPI.
- [jms](http