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 mit Attributen
  4. Anreichern mit XMLDoc
  5. Anreichern mit Code (tbd)
  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.

Related Articles

asp.net core
Anreichern 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
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
asp.net core
Einführung: ASP.NET Core API-Dokumentation mit Swagger: Teil 1 [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. Der erste Teil befasst sich damit welche Gründe für eine Dokumentation sprechen und wo der…
Sebastian Gingter