AsyncAPI

AsyncAPI is a Linux Foundation project that improves the state of event-driven architectures by providing an open specification and tooling ecosystem for defining asynchronous and event-driven APIs. It enables developers to document, validate, generate code, and manage message-driven APIs across protocols including Kafka, MQTT, WebSocket, AMQP, and others. The AsyncAPI specification serves as the industry standard for describing asynchronous messaging interfaces, similar to how OpenAPI serves REST APIs.

1 APIs 5 Features

Event-DrivenLinux FoundationMessagingStandardsSpecification

APIs

AsyncAPI Specification

The AsyncAPI Specification is an open standard for describing asynchronous and event-driven APIs. It provides a machine-readable format for defining messaging interfaces across ...

Collections

AsyncAPI Server API

OPEN

Pricing Plans

Asyncapi Plans Pricing

3 plans

PLANS

Rate Limits

Asyncapi Rate Limits

5 limits

RATE LIMITS

FinOps

Asyncapi Finops

FINOPS

Features

AsyncAPI Specification

An open specification standard for describing asynchronous and event-driven APIs, supporting multiple messaging protocols including Kafka, MQTT, WebSocket, AMQP, and more.

AsyncAPI Generator

Code and documentation generation tool that uses AsyncAPI definitions to produce boilerplate code, documentation, and other artifacts in multiple programming languages.

AsyncAPI CLI

Command-line interface tool for working with AsyncAPI files including validation, generation, and conversion operations from the terminal.

AsyncAPI Studio

Web-based editor and visualization tool for creating, editing, and previewing AsyncAPI specification documents with real-time validation.

Protocol Support

Broad protocol support covering Kafka, MQTT, WebSocket, AMQP, NATS, JMS, and other messaging protocols through a unified specification format.

Use Cases

Event-Driven API Documentation

Development teams use AsyncAPI to create machine-readable documentation for their message-driven APIs, making it easier for consumers to understand and integrate with event streams.

Code Generation for Messaging

Engineers generate boilerplate code for Kafka consumers, MQTT publishers, and other messaging clients directly from AsyncAPI specifications to accelerate development.

API Governance for Event-Driven Systems

Platform teams apply AsyncAPI specifications to enforce standards and governance across microservices architectures using event-driven communication.

Integrations

Apache Kafka

AsyncAPI supports defining Kafka-based event-driven APIs with topic, message schema, and broker configuration documentation.

MQTT Brokers

IoT and messaging platforms using MQTT can document their pub/sub interfaces using AsyncAPI specifications for device and service integration.

CI/CD Pipelines

AsyncAPI CLI integrates into continuous integration pipelines for automated validation and linting of AsyncAPI specification files.

Resources

AsyncAPI GitHub Organization

Sources

opencollection: 1.0.0
info:
  name: AsyncAPI Server API
  version: '1.0'
items:
- info:
    name: Validate
    type: folder
  items:
  - info:
      name: Validate an AsyncAPI document
      type: http
    http:
      method: POST
      url: http://localhost/validate
      body:
        type: json
        data: '{}'
    docs: Validate an AsyncAPI document
- info:
    name: Parse
    type: folder
  items:
  - info:
      name: Parse an AsyncAPI document
      type: http
    http:
      method: POST
      url: http://localhost/parse
      body:
        type: json
        data: '{}'
    docs: Parse an AsyncAPI document
- info:
    name: Convert
    type: folder
  items:
  - info:
      name: Convert an AsyncAPI document to another version or format
      type: http
    http:
      method: POST
      url: http://localhost/convert
      body:
        type: json
        data: '{}'
    docs: Convert an AsyncAPI document to another version or format
- info:
    name: Generate
    type: folder
  items:
  - info:
      name: Generate code or documentation from an AsyncAPI document
      type: http
    http:
      method: POST
      url: http://localhost/generate
      body:
        type: json
        data: '{}'
    docs: Generate code or documentation from an AsyncAPI document
- info:
    name: Bundle
    type: folder
  items:
  - info:
      name: Bundle multiple AsyncAPI documents
      type: http
    http:
      method: POST
      url: http://localhost/bundle
      body:
        type: json
        data: '{}'
    docs: Bundle multiple AsyncAPI documents
- info:
    name: Diff
    type: folder
  items:
  - info:
      name: Diff two AsyncAPI documents
      type: http
    http:
      method: POST
      url: http://localhost/diff
      body:
        type: json
        data: '{}'
    docs: Diff two AsyncAPI documents
- info:
    name: Help
    type: folder
  items:
  - info:
      name: Retrieve command and endpoint help
      type: http
    http:
      method: GET
      url: http://localhost/help
    docs: Retrieve command and endpoint help
bundled: true