Saltar al contenido
Explorar conocimiento

concepto · intermedio · 3 min de lectura

AsyncAPI

AsyncAPI es el equivalente de OpenAPI para APIs asíncronas y orientadas a eventos, describiendo canales, mensajes, protocolos y esquemas para sistemas basados en mensajería.

No requiere conocimientos previos.

Alcance en breve

Cubre

  • AsyncAPI as a concept

No cubre

  • implementation details

Supone

  • The reader understands relevant fundamentals.

Resumen

AsyncAPI es un estándar abierto para describir APIs orientadas a eventos y mensajería. Donde OpenAPI describe endpoints REST —síncronos, request-response—, AsyncAPI describe canales de mensajería, tópicos, colas, esquemas de mensajes, protocolos —Kafka, MQTT, AMQP, WebSockets— y bindings específicos de cada broker.

Importa porque la arquitectura orientada a eventos sufre de un problema de visibilidad: es difícil saber qué eventos existen, quién los produce y quién los consume sin leer código de múltiples servicios. Una spec AsyncAPI centraliza esa información y permite generar documentación, código y validaciones como OpenAPI hace para REST.

Alcance y supuestos

Cubre AsyncAPI como estándar de especificación para APIs asíncronas, su relación con OpenAPI y el ecosistema de herramientas. Asume familiaridad con mensajería y EDA.

Modelo mental

El tablero de anuncios de una comunidad. OpenAPI es el menú de un restaurante —pedís y te traen—. AsyncAPI es el tablero de anuncios: la comunidad publica avisos y cada residente lee los que le interesan. Ambos necesitan un formato común para que todos entiendan qué hay publicado.

Uso práctico

  • ✅ Sistemas basados en Kafka, RabbitMQ, MQTT.
  • ✅ Documentar quién publica y quién consume cada evento.

Ejemplo trabajado: spec AsyncAPI para un tópico de Kafka

asyncapi: 2.6.0
info:
  title: Order Events
  version: 1.0.0
channels:
  order-placed:
    publish:
      message:
        payload:
          type: object
          properties:
            orderId: { type: string }
            amount: { type: number }

Evidencia

  • AsyncAPI Initiative mantiene el estándar bajo la Linux Foundation. GLEE y AsyncAPI Generator son herramientas del ecosistema.

Fuentes citadas