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
- Einführung
- Einbindung
- Anreichern mit Attributen
- Anreichern einer Doku mit XMLDoc
- Anreichern einer Doku mit Code ⬅
- Dokumentation versionierter APIs
- Einbindung von Authentication und Authorization (tbd)
- Swagger-UI anpassen (tbd)
- Code-Generierung aus der Dokumentation (tbd)
- Verwendung der Dokumentation für Postman-Tests (tbd)
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.