asyncAPI: Standard zur Beschreibung asynchroner APIs
Einführung
asyncAPI bietet einen offenen Standard zur Beschreibung asynchroner APIs. Es ermöglicht eine konsistente Spezifikation von Kommunikationsschnittstellen zwischen Sender und Empfänger über Nachrichten.
Zielsetzung
Der Standard zielt darauf ab, die Dokumentation und Design von asynchronen Nachrichtensystemen zu vereinheitlichen. Durch die klare Spezifikation werden Implementierungsfehler reduziert und die Kommunikation zwischen Entwicklungsteams erleichtert.
Format und Version
Die Spezifikationen von asyncAPI werden im YAML-Format verfasst. Die aktuelle Version ist 3.0.0. YAML ermöglicht eine menschenlesbare und maschinenverarbeitbare Darstellung der API-Definitionen.
Hauptkomponenten von asyncAPI
info
Dieser Abschnitt enthält allgemeine Informationen über die API, wie Titel, Beschreibung, Version und Ansprechpartner.
servers
Hier werden die Adressierung und Beschreibung des Message Brokers definiert. Dies umfasst Details wie URL, Protokoll und Sicherheitsinformationen.
channels
Unter channels werden die Namen und Beschreibungen der Queues oder Topics angegeben. Jeder Channel repräsentiert einen Kommunikationsweg für Nachrichten.
operations
Die operations spezifizieren die Sende- und Empfangsarten für Nachrichten pro Channel. Sie definieren, ob ein Channel Nachrichten veröffentlicht (publish) oder abonniert (subscribe).
components
In diesem Abschnitt werden die Nachrichtenstrukturen definiert. components enthält die message-Definitionen, Datentypen und wiederverwendbare Objekte für die API.
Verfügbare Templates
Unter www.asyncapi.com stehen mehrere Templates zur Verfügung. Diese erleichtern die Erstellung und Darstellung der Spezifikationen, inklusive Generatoren für Dokumentation und Code.
asyncAPIAsynchroneAPIsYAMLAPIStandardMessageBrokerAPI-Spezifikation