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 Unterschied zwischen OpenAPI und Swagger liegt. Danach wird beleuchtet wie Swagger überhaupt in der Lage ist, aus unserem API-Projekt eine Dokumentation zu generieren.

1. Einführung ⬅
2. Einbindung
3. Anreichern einer Doku mit Attributen
4. Anreichern einer Doku mit XMLDoc
5. Anreichern einer Doku mit Code
6. Dokumentation versionierter APIs (tbd)
7. Einbindung von Authentication und Authorization (tbd)
8. Swagger-UI anpassen (tbd)
9. Code-Generierung aus der Dokumentation (tbd)
10. Verwendung der Dokumentation für Postman-Tests (tbd)

Inhalte des Screencasts

• OpenApi und Swagger (1:23 - 3:28)
• Swagger in .NET (3:28 - 8:08)

Im zweiten Teil wird es praktisch: Anhand eines konkreten Beispiels wird im Code gezeigt werden, wie man eine Swagger-Dokumentation mit UI in sein Projekt einbinden 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.