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 Sie, wie Sie die bisher eher rudimentäre Dokumentation aufpeppen.

Mit speziellen Attributen kann Swagger noch mehr Informationen über unsere API mitteilen und anzeigen lassen. Sebastiang Gingter zeigt wie. Außerdem sehen Sie wie es möglich ist, einzelne Endpunkte unserer API aus der Dokumentation auszuschließen.

Screencast-Serie

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

• Anreichern durch Attribute (0:55)
• Endpunkte ausnehmen (7:52)

Im nächsten und vierten Teil dieser Serie sehen Sie, wie Sie XML-Kommentare im Code auch in die Dokumentation bringen.

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.