Aus dem Kurs: Grundlagen der Programmierung: APIs und Webservices

So erhalten Sie Zugriff auf diesen Kurs

Werden Sie noch heute Mitglied und erhalten Sie Zugriff auf mehr als 24.100 Kurse von Branchenfachleuten.

Eine API dokumentieren

Eine API dokumentieren

Aus dem Kurs: Grundlagen der Programmierung: APIs und Webservices

Gratismonat starten Für Ihr Team erwerben

Eine API dokumentieren

“

Reden wir über das Dokumentieren einer API. Das nun Folgende ist sehr nützlich für Entwickler:innen und Software Engineers, die einen vorhandenen Webservice in ihren Anwendungen nutzen müssen. Das Tool der Wahl zur API-Dokumentation ist Swagger. Dieses Tool lässt Sie verstehen, wie eine API funktioniert. Wenn Sie eine REST-API erstellen, ist eine gute Dokumentation, die mit jeder Änderung aktualisiert wird, absolut unerlässlich. Diese manuell zu erstellen, ist eine mühsame Arbeit. Die Automatisierung mit Swagger spart Zeit. Dies hier ist nur ein Beispiel aus dem Swagger Petstore, das die API und alle verschiedenen Features und Operationen darauf zeigt. Nun mehr zu Swagger. Swagger besteht aus Open-Source-Tools, aufbauend auf der OpenAPI-Spezifikation, die ich hier zeige. Diese Spezifikation definiert einen Standard. Sie ist Programmiersprachen-agnostisch und im Grunde eine Beschreibung für REST-APIs. Letztlich hilft sie Ihnen beim Entwerfen, Erstellen, Dokumentieren und Nutzen von…

Inhalt