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 einer Doku mit Attributen
  4. Anreichern einer Doku mit XMLDoc
  5. Anreichern einer Doku mit Code
  6. Dokumentation versionierter APIs
  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

 | Sebastian Gingter

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 siebten Teil sehen Sie, wie eine API, die Authentifizierung benötigt, korrekt dokumentiert wird…

Read article
 | Sebastian Gingter

Screencast-Serie Einführung Einbindung Anreichern mit Attributen Anreichern mit XMLDoc Anreichern mit Code Dokumentation versionierter APIs ⬅ Einbindung von Authentication und Authorization (tbd) Swagger-UI anpassen (tbd) Code-Generierung aus der Dokumentation (tbd) Verwendung…

Read article
 | Sebastian Gingter

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…

Read article