Sebastian hat in seinem Webinar am 29.04.20 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?

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.

Recording des ASP.NET Core API-Dokumentations-Webinars

Inhalte

  • Warum überhaupt Dokumentation?
  • Wie dokumentiere ich eine ASP.NET Core Web API?
  • Technische Details
  • Was sonst? API Clients & Tests generieren
  • Q&A

Demo-Repository: https://github.com/thinktecture/tt-webinar-2020-openapi

Kostenloses Cheat Sheet zu API-Dokumenatation mit Swagger:
Sebastian Gingter hat zum Thema ASP.NET Core API Dokumentation mit Swagger ein Cheat Sheet erstellt, auf dem er kompakt alles Wissenswertes zusammengefasst hat. Melden Sie sich hier zu unseren monatlichen DevNews an und wir senden Ihnen das Cheat Sheet per E-Mail.

Slidedeck zum API-Dokumentations-Webinar


Related Articles

asp.net core
Einbindung von Versionierung in existierende Projekte: API-Versionierung mit ASP.NET Core 3.0 - Teil 4 [Screencast]
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…
Sebastian Gingter
asp.net core
Konfiguration: API-Versionierung mit ASP.NET Core 3.0 - Teil 3 [Screencast]
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…
Sebastian Gingter
asp.net core
Einbindung der Versionierung, Controller & Actions: API-Versionierung mit ASP.NET Core 3.0 - Teil 2 [Screencast]
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 befasst damit, wie Versionierung in ein neues…
Sebastian Gingter
asp.net core
Warum versionieren, Versionsauswahl, Möglichkeiten: API-Versionierung mit ASP.NET Core 3.0 - Teil 1 [Screencast]
Inhalte des Screencasts Warum API-Versionierung? Gründe, die für die Versionierung einer API sprechen, wann man API-Versionierung (nicht) in Betracht ziehen sollte und welche Kriterien dafür sprechen, eine neue Version einzuführen. Versionsauswahl: Es werden vier verschiedene…
Sebastian Gingter