Extra Credit

AsyncAPI

Official docs outline

13 sections
  1. What is AsyncAPI

    What AsyncAPI is and how it describes event-driven APIs, messages and channels.

  2. AsyncAPI document

    The structure of an AsyncAPI document and its top-level fields.

  3. Servers

    Defining servers, protocols, hosts and variables for a broker.

  4. Channels

    Channels and their addresses for publishing and subscribing to messages.

  5. Operations

    Operations of action send or receive that apply to a channel.

  6. Messages and payloads

    Message objects, payload schemas, headers and examples.

  7. Bindings

    Protocol bindings for Kafka, MQTT, AMQP, WebSockets and others.

  8. Components and reuse

    Reusable components, $ref references and traits.

  9. Security

    Security schemes for servers and operations.

  10. Specification

    The full AsyncAPI specification reference.

  11. Generator

    Generating documentation and code from AsyncAPI documents.

  12. CLI

    The AsyncAPI CLI for validating, converting and generating from documents.

  13. Getting started tutorial

    A tutorial for writing a first AsyncAPI document.

Each section links to the official page. Titles and summaries by Extra Credit; the docs belong to their authors.

All 41