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.

Recording des ASP.NET Core API-Dokumentation-Webinars

Inhalte

  • Warum überhaupt API-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

Slidedeck zum Webinar


Related Articles

asp.net core
Anreichern einer Doku mit Code: ASP.NET Core API-Dokumentation mit Swagger - Teil 5 [Screencast]
Thinktecture Backend- und API-Spezialist Sebastian Gingter zeigt in dieser 10-teiligen Screencast-Serie wie man seine ASP.NET Core 3.1-API mithilfe von Swagger dokumentieren kann. Im fünften Teil sehen Sie, wie Sie die XML-Kommentare im Code auch in die Dokumentation bringen, das…
Sebastian Gingter
asp.net core
Anreichern einer Doku mit XMLDoc: ASP.NET Core API-Dokumentation mit Swagger - Teil 4 [Screencast]
Thinktecture Backend- und API-Spezialist Sebastian Gingter zeigt in dieser 10-teiligen Screencast-Serie wie man seine ASP.NET Core 3.1-API mithilfe von Swagger dokumentieren kann. Im vierten Teil sehen Sie, wie XML-Doc-Kommentare im Code auch in das Swagger-Dokument gelangen.…
Sebastian Gingter
asp.net core
Advanced ASP.NET Core Web APIs: Swagger & Co im Praxiseinsatz für Tests und Clients [Talk]
Als Entwickler wollen wir uns das Leben möglichst einfach machen. Und wenn wir eine Aufgabe vor uns haben, dann wollen wir auch möglichst viel damit erreichen. Nun haben wir eine ASP.NET-Core-Web-API gebaut und sie mit Hilfe von Swagger dokumentiert. Und nun? In seinem Talk auf…
Sebastian Gingter
asp.net core
Anreichern einer Doku mit Attributen: ASP.NET Core API-Dokumentation mit Swagger - Teil 3 [Screencast]
Thinktecture Backend- und API-Spezialist Sebastian Gingter zeigt in dieser 10-teiligen Screencast-Serie wie man seine ASP.NET Core 3.1-API mithilfe von Swagger dokumentieren kann. Im dritten Teil sehen Sie, wie Sie die bisher eher rudimentäre Dokumentation aufpeppen. Mit…
Sebastian Gingter