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.
Über diese Screencast-Serie
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.
Screencast-Serie:
- Einführung
- Einbindung
- Anreichern einer Doku mit Attributen
- Anreichern einer Doku mit XMLDoc
- Anreichern einer Doku mit Code
- Dokumentation versionierter APIs
- Einbindung von Authentication und Authorization ⬅
- Swagger-UI anpassen
- Code-Generierung aus der Dokumentation
- Verwendung der Dokumentation für Postman-Tests
Screencast: Einbindung von Authentication & Authorization
Zum nächsten Teil: Swagger-UI anpassen
Im nächsten und achten Teil dieser Serie sehen Sie, welche Modifikationen Sie am Swagger-UI vornehmen können.