Einführung
Die Software, die Sie entwickeln, zu dokumentieren, bringt eine Menge Vorteile mit sich. Mit einer zuverlässigen Dokumentation lässt sich Ihr Code über die Zeit nicht nur besser pflegen, sondern ist für andere auch leichter zu nutzen. Dafür zu sorgen, dass sich Ihr Code leichter verwenden lässt, ist vor allem dann wichtig, wenn Sie eine API entwickeln, die andere nutzen möchten. Glücklicherweise gibt es Tools und Frameworks, mit denen sich die Kosten für die Erstellung einer guten Dokumentation senken lassen.
Angenommen, Sie sind der leitende Entwickler für ein Unternehmen für Druckrahmen. Ihr Unternehmen möchte seine APIs öffentlich verfügbar machen. Für viele APIs gibt es keine Dokumentation, und Sie haben nun die Aufgabe, diese APIs zu dokumentieren. Wenn Sie die APIs dokumentieren, ist es für Ihre Partner leichter, die APIs wie vorgesehen zu verwenden, wodurch geringere Support- und Wartungskosten anfallen.
Sie benötigen eine einfache und standardisierte Methode zum Dokumentieren der einzelnen APIs. Außerdem benötigen Sie eine Methode zum Hosten der Dokumentation an einem Ort, der für die Partner zugänglich ist.
In diesem Modul erfahren Sie, wie eine vorhandene ASP.NET Core-API mit Swashbuckle, Swagger, Swagger UI und OpenAPI dokumentiert wird.
Lernziele
In diesem Modul lernen Sie Folgendes:
- Informationen zu Swashbuckle, OpenAPI und Swagger UI
- Aktivieren von OpenAPI für eine C#/ASP.NET Core-API
- Verwenden von Swashbuckle in einer C#/ASP.NET Core-API
- Generieren und Anzeigen einer API-Dokumentation mit OpenAPI
Voraussetzungen
- Erfahrungen mit dem Entwurf und der Implementierung einer REST-API
- Erfahrungen mit der Entwicklung einfacher ASP.NET Core-Apps
- Lokale Installationen von .NET SDK, Visual Studio Code und der C#-Erweiterung für Visual Studio Code.