Dokumentation zur Verbesserung der Entwickleroberfläche einer API mit Swagger

Anfänger
Entwickler
Azure
Azure CLIs
ASP.NET Core

Hier erfahren Sie, wie Sie eine vorhandene in C#/ASP.NET Core geschriebene API mit Swashbuckle, Swagger/OpenAPI und Swagger UI dokumentieren.

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 Installation des .NET SDK
  • Visual Studio Code
  • C#-Erweiterung für Visual Studio Code