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 fünften Teil sehen Sie, wie Sie die XML-Kommentare im Code auch in die Dokumentation bringen, das generierte Dokument im Gesamten anpassen und einzelne Endpunkte individuell modifizieren können.

Screencast-Serie

1. Einführung
2. Einbindung
3. Anreichern mit Attributen
4. Anreichern einer Doku mit XMLDoc
5. Anreichern einer Doku mit Code ⬅
6. Dokumentation versionierter APIs
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

• DocumentFilter (0:39)
• OperationFilter (6:29)

Im nächsten und sechsten Teil dieser Serie geht es darum, wie man vorgehen muss um mehrere API-Versionen gleichzeitig zu dokumentieren.

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