Im zehnten und letzten Teil sehen Sie, wie Sie aus der Dokumentation auch Postman-Tests generieren können.
Im neunten Teil sehen Sie, wie aus unserer Dokumentation vollständige Clients generiert werden können.
Im achten Teil sehen Sie, welche Modifikationen Sie am Swagger-UI vornehmen können. Zum Beispiel die Einbindung eines eigenen Logos in die Dokumentation oder einige weitere Features die Swagger mitbringt, welche aber nicht von Beginn an aktiviert sind.
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.
