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 dritte Teil damit, wie die Versionierung weiter konfiguriert werden kann. Außerdem werden zwei Methoden gezeigt, wie die Versionen angeboten und Einzelne als veraltet markiert werden können.

Inhalte des Screencasts

  • Konfigurieren von API-Versionierung: Das API-Versionierungspaket erlaubt es dem Client die unterstützten Versionen mittels HTTP-Headern mitzuteilen.
  • Versionsauswahl - HTTP-Header: Die Versionsauswahl kann umgestellt werden, so dass ein Client die Version nicht mehr mittels Query-Parametern bestimmen muss, sondern mittels HTTP-Headern auswählen kann.
  • Versionauswahl - URL-Pfad: Außerdem kann die Versionsauswahl insofern angepasst werden, dass ein Client die Version nicht mehr mittels Query-Parametern oder HTTP-Headern auswählen muss, sondern über den Pfad zum Endpunkt bestimmen kann.
  • API als veraltet markieren: Eine API muss und kann nicht für immer alle alten Endpunkte unterstützen. Damit die Clients erfahren, dass eine bestimmte Version veraltet ist und gegebenenfalls demnächst abgeschaltet wird, wird gezeigt, wie man dies konfigurieren kann.
  • Ausblick auf Teil 4: Im letzten Teil geht es darum, wie man API-Versionierung nachträglich in ein existierendes Projekt einbindet und dabei einzelne Endpunkte von der Versionierung exkludiert. Dazu wird ein weiterer möglicher Weg gezeigt, wie ein Client die Version bestimmen kann und wir im Code herausfinden, welche Version der Client überhaupt gerade abgefragt hat.

Wenn Sie die weiteren Teile der API-Versionierungs-Serie und weiter Artikel unserer Experten nicht verpassen möchten, melden Sie sich für unsere monatlichen Tech News an.

Kostenloses Cheat Sheet zu ASP.NET Core API-Dokumentation mit Swagger

Sebastian Gingter zeigt Ihnen auf wenigen Seiten übersichtlich zusammengefasst, was Sie bei der Dokumentation Ihrer ASP.NET Core API wissen sollten.

Melden Sie sich kostenlos zu unserem Newsletter an, um das Cheat Sheet per E-Mail zu erhalten.

Related Articles

asp.net core
Anreichern 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 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
asp.net core
Einbindung: ASP.NET Core API-Dokumentation mit Swagger: Teil 2 [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. Nach der Einführung in Teil 1, wird es im zweiten Teil praktisch und Sie sehen Code. Im Screencast…
Sebastian Gingter