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 (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

  • 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.

Related Articles

asp.net core
Anreichern einer Doku mit XMLDoc: ASP.NET Core API-Dokumentation mit Swagger - Teil 4 [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 vierten Teil sehen Sie, wie XML-Doc-Kommentare im Code auch in das Swagger-Dokument gelangen.…
Sebastian Gingter
asp.net core
Advanced ASP.NET Core Web APIs: Swagger & Co im Praxiseinsatz für Tests und Clients [Talk]
Als Entwickler wollen wir uns das Leben möglichst einfach machen. Und wenn wir eine Aufgabe vor uns haben, dann wollen wir auch möglichst viel damit erreichen. Nun haben wir eine ASP.NET-Core-Web-API gebaut und sie mit Hilfe von Swagger dokumentiert. Und nun? In seinem Talk auf…
Sebastian Gingter
asp.net core
Anreichern einer Doku 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 Sie, wie Sie die bisher eher rudimentäre Dokumentation aufpeppen. Mit…
Sebastian Gingter
asp.net core
Einbindung: ASP.NET Core API-Dokumentation mit Swagger: Teil 2 [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. Nach der Einführung in Teil 1, wird es im zweiten Teil praktisch und Sie sehen Code. Im Screencast…
Sebastian Gingter