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 letzte Teil um die Einbindung in ein existierendes Projekt und wie man dabei einzelnen Endpunkte von der Versionierung ausnimmt.

Dazu wird ein weiterer Möglichkeit dargestellt, die Version durch den Client zu bestimmen und gezeigt, wie im Code ersichtlich wird welche Version der Client überhaupt gerade abgefragt hat.

im Code ersichtlich ist, welche Version der Client überhaupt gerade abgefragt hat.

Inhalte des Screencasts

  • Einbindung in ein existierendes Projekt: Nicht alle Projekte starten auf der grünen Wiese. Es wird gezeigt, wie API-Versionierung in ein existierendes Projekt eingebunden wird und worauf man achten sollte, wenn Default-Versionen konfiguriert werden, da alte Clients die Versionierung noch nicht kennen und daher keine Version abfragen.
  • Endpunkte von der Versionierung ausschließen: So gehts: Manchmal möchte man Endpunkte explizit von der Versionierung ausschließen, weil sie in allen Versionen der API gleichermaßen zur Verfügung stehen sollen.
  • Custom Header Versioning: Die Versionsauswahl kann so umgestellt werden, dass ein Client die Version nicht mittels Query-Parametern, HTTP-Accept-Headern oder im Pfad auswählen muss, sondern dies über einen individuellen, spezialisierten Header tun kann.
  • Angeforderte Version im Code abfragen: Manchmal ist es notwendig im Code zu unterscheiden, welche Version gerade abgefragt wurde, um ein bestimmtes Verhalten des Endpunktes bei alten Versionen beizubehalten.

Den Demo-Code der Screencast-Serie finden Sie hier.

Wenn Sie in Zukunft die weiteren Artikel, Screeencasts und Webinare von Sebastian Gingter und unserer Experten nicht verpassen möchten, melden Sie sich für unseren Newsletter 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

 | Sebastian Gingter

Sebastian Gingter stellt vor, welche Möglichkeiten sich bieten um aus dem Dokumentations-Dokument eine Postman-Collection zu generieren sowie welche Anpassungen getroffen werden müssen. So sollten ein paar Variablen und die Authentifizierung konfiguriert werden. Außerdem gibt es…

Read article
 | Sebastian Gingter

Erfahren Sie im Screencast, wie Sie einen komplett generierten Client einfach von einem kostenlosen Swagger Online-Service herunterladen können. Als Alternative dazu lernen Sie die Grundlagen kennen, wie Sie ein existierendes Template anpassen oder gleich von Grund auf mit einem…

Read article
 | Sebastian Gingter

Damit auch die Anforderungen an die Authentifizierung in der Dokumentation zu finden sind, müssen diese noch eingebunden werden. Im Kapitel 'Anmeldeinformationen im Swagger-Dokument' wird die Vorgehensweise gezeigt. Darüber hinaus soll die API auch weiterhin vom Swagger-UI aus…

Read article