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
  7. Einbindung von Authentication und Authorization
  8. Swagger-UI anpassen
  9. Code-Generierung aus der Dokumentation
  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

 | Sebastian Gingter

Erfahren Sie im Screencast, wie Sie einen komplett generierten Client einfach von einem kostenlosen Swagger Online-Service herunterladen können. Als Alternative dazu lernen Sie die Grundlagen kennen, wie Sie ein existierendes Template anpassen oder gleich von Grund auf mit einem…

Read article
 | Sebastian Gingter

Damit auch die Anforderungen an die Authentifizierung in der Dokumentation zu finden sind, müssen diese noch eingebunden werden. Im Kapitel 'Anmeldeinformationen im Swagger-Dokument' wird die Vorgehensweise gezeigt. Darüber hinaus soll die API auch weiterhin vom Swagger-UI aus…

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 Swagger-UI anpassen Code-Generierung aus der Dokumentation Verwendung der Dokumentation…

Read article