Aus dem Kurs: ASP.NET Core 3.1 Web API Grundkurs

So erhalten Sie Zugriff auf diesen Kurs

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

APIs dokumentieren

APIs dokumentieren – Tutorial zu ASP.NET Core

Aus dem Kurs: ASP.NET Core 3.1 Web API Grundkurs

Gratismonat starten Für Ihr Team erwerben

APIs dokumentieren

“

Eine API gehört dokumentiert, eine öffentliche sowieso, aber auch eine nicht öffentliche. Irgendwann haben wir auch Nachfolger und die müssen mit dem arbeiten, was wir geschaffen haben. Außerdem hat ja eine API viele Clients, die sie konsumieren und auch diejenigen Personen, die diese Clients erstellen, müssen wissen, was sie tun können und tun sollen. Jetzt gibt es ja auch diverse Möglichkeiten, Versuche, bestimmte Dinge zu standardisieren und ich will Ihnen einen ganz bestimmten Weg aufzeigen, der ist nämlich ziemlich populär und, wie ich finde, auch ganz praktisch. Und zwar will ich kurz über Swagger sprechen. Swagger ist ein Framework eben für die Dokumentation von APIs, also ein komplettes Rahmenwerk, wo wir dann diverseste Möglichkeiten haben für eine Dokumentation und wie wir Dokumentationsinformationen bereitstellen für beispielsweise Oberflächen, die diese Versionsinformationen und API-Informationen visualisieren. Zufällig gibt es da auch noch ein weiteres Projekt, nämlich…

Inhalt