- 10:30 Uhr
- Sebastian Gingter
Webinar: ASP.NET Core Web API-Dokumentation mit Swagger
Sebastian hat in seinem Webinar am 07. Oktober 2020 erklärt, wie man sich viel Zeit sparen kann durch lebende API-Dokumentationen. Wenn wir eine .NET Core Web-API bauen, ist es nicht nur damit getan, ein neues Projekt zu erzeugen, ein paar Controller zu implementieren und sie dann zu deployen.
Eine API ist - wie der Name schon sagt - eine Schnittstelle, und eine Schnittstelle sollte wohl definiert und auch wohl dokumentiert sein. Vor allem, damit die Entwickler, die mit unserer API arbeiten müssen, auch wissen was sie kann und wie sie funktioniert. Allerdings soll uns die Dokumentation nicht zu viel Zeit kosten und sie sollte möglichst immer auf dem aktuellen Stand sein. Und was wäre, wenn eine solche, schnell erstellte Dokumentation uns als API-Entwickler und auch den Konsumenten unserer API auch noch Arbeit abnehmen könnte?
Sebastian Gingter zeigt, wie man diese beiden Fliegen mit einer Klappe schlagen kann: Mit Hilfe von Swagger erzeugen wir erst eine umfassende, ständig aktuelle und lebendige Dokumentation unserer API im OpenAPI-Format. Danach sehen wir uns an, wie uns diese technische Dokumentation helfen kann, zum einen Zeit zu sparen und zum anderen Fehler zu vermeiden, in dem wir diese akkurate Basis nehmen, um Client- Code und Test-Rümpfe zu generieren. Web APIs jenseits von Hello World, mit viel Projekterfahrung.
Moderation
Gøran Homberg
Gøran Homberg ist Consultant bei Thinktecture und arbeitet mit unseren Kunden bzgl. deren Anforderungen, Projektansätzen und zugehörigem Projekt-Management.
Agenda
- Warum überhaupt API-Dokumentation?
- Wie dokumentiere ich eine ASP.NET Core Web-API?
- Technische Details
- Was sonst? API-Clients & Tests generieren
- Q&A
Material & Video zu "ASP.NET Core Web API-Dokumentation mit Swagger"
Links aus dem Webinar:
Sie wünschen sich Unterstützung durch unsere Experten in Ihrem Projekt?
Slidedeck zu "ASP.NET Core Web API-Dokumentation mit Swagger"
Kommende Webinare: jetzt kostenlos anmelden
Turbo RAG: AI-basierte Retriever-Auswahl mit Semantic Router
Marco Frodl | 12.02.2025 | 10:30 Uhr
Aktuelle Webinar-Aufzeichnungen
Max Marschall | 04.12.2024 | 10:30 Uhr
Christian Liebel | 18.12.2024 | 10:30 Uhr
Daniel Sogl | 13.11.2024 | 10:30 Uhr
Weitere Artikel zu API, ASP.NET Core
Data Access in .NET Native AOT with Sessions
Native AOT with ASP.NET Core – Overview
Architektur-Modernisierung: Migration von WCF zu gRPC mit ASP.NET Core – ein pragmatischer Ansatz
Viele Projekte mit verteilten Anwendungen in der .NET-Welt basieren noch auf der Windows Communication Foundation (WCF). Doch wie kommt man weg von der "Altlast" und wie stellt man seinen Code auf sowohl moderne als auch zukunftssichere Beine? Eine mögliche Lösung ist gRPC.