Einbindung von Authentication & Authorization: ASP.NET Core API-Dokumentation mit Swagger – Teil 7 [Screencast]
Im siebten Teil sehen Sie, wie eine API, die Authentifizierung benötigt, korrekt dokumentiert wird.
Im siebten Teil sehen Sie, wie eine API, die Authentifizierung benötigt, korrekt dokumentiert wird.
Im sechsten Teil sehen Sie wie Sie vorgehen können, um mehrere API-Versionen gleichzeitig zu dokumentieren und wie Sie diese Versionen in SwaggerUI einbinden.
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.
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.
Mit speziellen Attributen kann Swagger noch mehr Informationen über unsere API mitteilen und anzeigen lassen. Sebastiang Gingter zeigt wie.
Außerdem sehen Sie wie es möglich ist, einzelne Endpunkte unserer API aus der Dokumentation auszuschließen.
Im Screencast erfahren Sie, wie Sie die Generierung eines OpenAPI-Dokuments in ein ASP.NET Core Web API–Projekt einbinden.
Außerdem sehen Sie, wie man das SwaggerUI direkt im Projekt aktiviert.
Da es nicht immer gewünscht ist, das Swagger-Dokument direkt über einen Endpunkt auf seiner API zur Laufzeit abrufen zu können, zeigt Sebastian Gingter einen alternativen Weg, wie Sie dieses Dokument nach dem Kompilieren des API-Projektes, zum Beispiel auch als Teil des Build-Prozesses, generieren können.
Der erste Teil befasst sich damit, welche Gründe für eine Dokumentation sprechen und wo der Unterschied zwischen OpenAPI und Swagger liegt.
Danach wird beleuchtet wie Swagger überhaupt in der Lage ist, aus unserem API-Projekt eine Dokumentation zu generieren.
Thinktecture Backend- und API-Spezialist Sebastian Gingter zeigt in dieser vierteiligen Screencast-Serie, wie eine ASP.NET Core 3.0 API versioniert wird. Nach einer Einführung in die API-Versionierung, der Integration in neue Projekte und Hinweisen zur Konfiguration, geht es im letzte Teil um die Einbindung in ein existierendes Projekt und wie man dabei einzelnen Endpunkte von der Versionierung ausnimmt.
Thinktecture Backend- und API-Spezialist Sebastian Gingter zeigt in dieser vierteiligen Screencast-Serie wie man
seine ASP.NET Core 3.0 API versionieren kann. Nach der Einführung in die Versionierung und der Erläuterung über die Integration in neue Projekte, befasst sich der dritte Teil damit, wie die Versionierung weiter konfiguriert werden kann. Außerdem werden zwei Methoden gezeigt, wie die Versionen angeboten und Einzelne als veraltet markiert werden können.
Thinktecture Backend- und API-Spezialist Sebastian Gingter zeigt in dieser vierteiligen Screencast-Serie wie man seine ASP.NET Core 3.0 API versionieren kann. Nach der Einführung in die API-Versionierung, befasst sich der zweite Teil damit, wie Versionierung in ein neues API-Projekt eingebunden wird und zeigt zwei Möglichkeiten, Versionen für seine Controller und Actions zu definieren.