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. Außerdem werden dieses durch Beispieldaten angereichert und die Auswirkungen geprüft.

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

  • Anreichern durch XML-Doc Kommentare (0:36)
  • Anreichern mit Beispieldaten (3:58)

Im nächsten und fünften Teil dieser Serie sehen Sie, welche Möglichkeiten noch zur Verfügung stehen, mit eigenem Code die generierte Dokumentation anzupassen.

Wenn Sie die weiteren Teile der API-Dokumentations-Serie und Artikel unserer Experten nicht verpassen möchten, registrieren Sie sich kostenlos für unseren monatlichen Tech Newsletter.

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