Структура документа

Корневой объект AsyncAPI

Поле	Описание
asyncapi	Обязательное. Версия спецификации, например 2.6.0 (не версия вашего API).
id	Идентификатор приложения в формате URI, например urn:example:orders.
info	Обязательное. Сведения о приложении.
servers	Серверы (брокеры), к которым подключается приложение.
defaultContentType	Тип содержимого сообщений по умолчанию, например application/json.
channels	Обязательное. Каналы и операции приложения.
components	Переиспользуемые объекты.
tags	Теги для группировки.
externalDocs	Внешняя документация.

Info

Поле	Описание
title	Обязательное. Название приложения.
version	Обязательное. Версия API приложения.
description	Описание (CommonMark).
termsOfService	Ссылка на условия использования.
contact	name, url, email.
license	name (обязательное), url.

Server — сервер (брокер)

В servers — объект «имя → сервер». В 2.0 сервер описывается адресом url.

Поле	Описание
url	Обязательное. Адрес брокера; может содержать переменные в фигурных скобках.
protocol	Обязательное. Протокол: kafka, kafka-secure, amqp, amqps, mqtt, mqtts, ws, wss, http, https, jms, nats, redis, sns, sqs, stomp и др.
protocolVersion	Версия протокола, например 0.9.1 для AMQP.
description	Описание.
variables	Переменные для url (default, enum, description, examples).
security	Схемы безопасности подключения.
bindings	Настройки сервера, специфичные для протокола.

asyncapi: 2.6.0
id: urn:example:shop:orders
info:
  title: Сервис заказов
  version: 1.2.0
  description: |
    Публикует события жизненного цикла заказа и принимает команды на отмену.
  contact:
    name: Команда заказов
    email: orders@example.ru
  license:
    name: Apache 2.0
defaultContentType: application/json
servers:
  production:
    url: kafka.example.ru:9092
    protocol: kafka
    description: Продуктивный кластер
  test:
    url: '{env}.kafka.example.ru:9092'
    protocol: kafka
    variables:
      env:
        default: test
        enum: [test, preprod]
channels:
  orders.created:
    subscribe:
      message:
        payload:
          type: object
tags:
  - name: Заказы
externalDocs:
  url: https://example.ru/docs/events