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 erfahren Sie, wie Sie die Generierung eines OpenAPI-Dokuments in ein ASP.NET Core Web API–Projekt einbinden. Außerdem sehen Sie, wie man das SwaggerUI direkt im Projekt aktiviert. Da es nicht immer gewünscht ist, das Swagger-Dokument direkt über einen Endpunkt auf seiner API zur Laufzeit abrufen zu können, zeigt Sebastian Gingter einen alternativen Weg, wie Sie dieses Dokument nach dem Kompilieren des API-Projektes, zum Beispiel auch als Teil des Build-Prozesses, generieren können.

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

  • OpenAPI Dokument generieren (0:51)
  • SwaggerUI einbinden (10:11)
  • Dokument ‘offline’ generieren (12:40)

Im nächsten und dritten Teil dieser Screencast-Serie sehen Sie, wie die bisher doch sehr rudimentäre Dokumentation etwas aufgepeppt werden kann.

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