Thinktecture Backend- und API-Spezialist Sebastian Gingter zeigt in dieser 10-teiligen Screencast-Serie wie man seine ASP.NET Core 3.1 API mithilfe von Swagger dokumentieren kann. Nach der Einführung in Teil 1, wird es im zweiten Teil praktisch und wir sehen Code.

Im Screencast erfahren Sie, wie Sie die Generierung eines OpenAPI-Dokuments in ein ASP.NET Core Web API–Projekt einbinden. Außerdem sehen Sie, wie man das SwaggerUI direkt im Projekt aktiviert. Da es nicht immer gewünscht ist, das Swagger-Dokument direkt über einen Endpunkt auf seiner API zur Laufzeit abrufen zu können, zeigt Sebastian Gingter einen alternativen Weg, wie Sie dieses Dokument nach dem Kompilieren des API-Projektes, zum Beispiel auch als Teil des Build-Prozesses, generieren können.

Inhalte des Screencasts

  • OpenAPI Dokument generieren (0:51)
  • SwaggerUI einbinden (10:11)
  • Dokument ‘offline’ generieren (12:40)

Im nächsten und dritten Teil dieser Screencast-Serie werden wir sehen, wie die bisher doch sehr rudimentäre Dokumentation etwas aufgepeppt werden kann.

Wenn Sie die weiteren Teile der API-Dokumentations-Serie und weiter Artikel unserer Experten nicht verpassen möchten, melden Sie sich für unsere monatlichen Tech News an.

Related Articles

asp.net core
Anreichern mit Attributen: ASP.NET Core API-Dokumentation mit Swagger - Teil 3 [Screencast]
Thinktecture Backend- und API-Spezialist Sebastian Gingter zeigt in dieser 10-teiligen Screencast-Serie wie man seine ASP.NET Core 3.1-API mithilfe von Swagger dokumentieren kann. Im dritten Teil sehen wir, wie man die bisher eher rudimentäre Dokumentation aufpeppt. Mit…
Sebastian Gingter
asp.net core
Einführung: ASP.NET Core API-Dokumentation mit Swagger: Teil 1 [Screencast]
Thinktecture Backend- und API-Spezialist Sebastian Gingter zeigt in dieser 10-teiligen Screencast-Serie wie man seine ASP.NET Core 3.1 API mithilfe von Swagger dokumentieren kann. Der erste Teil befasst sich damit welche Gründe für eine Dokumentation sprechen und wo der…
Sebastian Gingter
asp.net core
Einbindung von Versionierung in existierende Projekte: API-Versionierung mit ASP.NET Core 3.0 - Teil 4 [Screencast]
Thinktecture Backend- und API-Spezialist Sebastian Gingter zeigt in dieser vierteiligen Screencast-Serie, wie eine ASP.NET Core 3.0 API versioniert wird. Nach einer Einführung in die API-Versionierung, der Integration in neue Projekte und Hinweisen zur Konfiguration, geht es im…
Sebastian Gingter
asp.net core
Konfiguration: API-Versionierung mit ASP.NET Core 3.0 - Teil 3 [Screencast]
Thinktecture Backend- und API-Spezialist Sebastian Gingter zeigt in dieser vierteiligen Screencast-Serie wie man seine ASP.NET Core 3.0 API versionieren kann. Nach der Einführung in die Versionierung und der Erläuterung über die Integration in neue Projekte, befasst sich der…
Sebastian Gingter