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?
In diesem Webinar zeigt Ihnen Sebastian Gingter 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 Open API 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.
Wann
Mittwoch, April 29, 2020 · 10:30 a.m.
Berlin (GMT +2:00)
Das Webinar wurde beendet
Agenda
Warum überhaupt Dokumentation?
Wie dokumentiere ich eine ASP.NET Core Web API?
Technische Details
Was sonst? API Clients & Tests generieren
Q&A
Moderatoren
Sebastian Gingter
Consultant @ Thinktecture AG
Sebastian Gingter ist Consultant und "Erklärbär" bei Thinktecture. Seine Spezialgebiete sind Backend-Systeme mit .NET Core und IdentityServer.
Marco Frodl
Consultant @ Thinktecture AG
Cross-Platform, Angular (SPA,PWA), .Net Core and Cloud Enthusiast.