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.

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 getestet werden können. Damit dies möglich ist, muss eine Anmeldung möglich sein. Wie wir das Swagger-UI als Client in unserem Authentifizierungs-System konfigurieren wird ebenfalls im Screencast demonstriert.

Screencast-Serie

  1. Einführung
  2. Einbindung
  3. Anreichern mit Attributen
  4. Anreichern mit XMLDoc
  5. Anreichern 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

  • Anmeldeinformationen im Swagger-Dokument (1:28)
  • Security in Swagger UI einbinden (9:25)

Im nächsten und achten Teil dieser Serie sehen Sie, welche Modifikationen Sie am Swagger-UI vornehmen können.

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

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

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