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
  8. Swagger-UI anpassen
  9. Code-Generierung aus der Dokumentation
  10. Verwendung der Dokumentation für Postman-Tests

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

Sebastian Gingter stellt vor, welche Möglichkeiten sich bieten um aus dem Dokumentations-Dokument eine Postman-Collection zu generieren sowie welche Anpassungen getroffen werden müssen. So sollten ein paar Variablen und die Authentifizierung konfiguriert werden. Außerdem gibt es…

Read article
 | 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