AsyncAPI- Swagger für MQTT? Automatisierte Dokumentation von eventbasierten APIs

In Kooperation mit der Usergroup "Write the Docs Karlsruhe" wird Frieder Reinhold, Principal Consultant bei EXXETA, einen Einblick in ein Automotive-Projekt zur automatisierten Doku von asynchronen APIs (MQTT) geben.

Im modernen Microservice-Umfeld reicht eine REST-Schnittstelle oft nicht mehr aus. Es besteht der Bedarf einer asynchronen und event-getriebenen Kommunikation zwischen Diensten oder Zuliefersoftware. Dies wird oft durch Message Queues wie z.B. MQTT gelöst. Mit OpenAPI (ehemals Swagger) steht eine ausgereift und weit verbreitete Technologie zur Dokumentation zur Verfügung. Es kann sowohl Code aus Dokumentation, als auch Dokumentation aus Code erstellt werden. D.h. es ist zu jeder Zeit klar, welche REST-Endpunkte es gibt und welche Payloads versendet oder entgegengenommen werden. Die Zusammenarbeit verschiedener Software-Entwickler bzgl. einer Rest-Schnittstelle wird dadurch deutlich vereinfacht. Wie ist das bei asynchronen APIs wie MQTT? Auf welche Topics hört ein Server, welche Topics versendet er selbst, welche Payloads erwartet oder versteht er. Bisher gibt es hier keine verbreitete Technik zur Dokumentation. AsyncAPI tritt an um dieses Lücke zu füllen. Mit der expliziten Nähe zu OpenAPI soll der Einstieg und die Verwendung beider Technologien vereinfacht werden. Kann AsyncAPI die Erwartungen erfüllen? Im Meetup beschäftigen wir uns damit warum man AsyncAPI braucht und welche Alternativen es gibt. Zusammen werden wir die aktuellen Möglichkeiten der AsyncAPI ausprobieren und auf Praxistauglichkeit testen.