BASTA! Hybrid 2020 - ASP.NET Core API Versionierung aus der Praxis

by Sebastian Gingter

Slide 1

Slide 1 text

1 direkt aus der Praxis

Slide 2

Slide 2 text

No content

Slide 3

Slide 3 text

3 direkt aus der Praxis ▪ ▪ ▪ ▪ ▪ ▪ ▪ ▪ ▪ Twitter:

Slide 4

Slide 4 text

4 ▪ ▪ ▪ ▪ ▪ direkt aus der Praxis

Slide 5

Slide 5 text

5 direkt aus der Praxis

Slide 6

Slide 6 text

6 • Anforderungen ändern sich • APIs verändern sich zwangsläufig mit • Breaking changes können nicht ausgeschlossen werden direkt aus der Praxis • Bei (öffentlichen) APIs, deren Clients nicht unter eigener Kontrolle sind

Slide 7

Slide 7 text

7 • Endpunkte • Entfernen von Endpunkten • Hinzufügen von neuen Pflichtparametern • Änderungen am Verhalten von Endpunkten • Datenmodell • Entfernen oder Umbenennen von vorher gelieferten Daten • Ändern von Datentypen • Hinzufügen neuer Pflichtdaten beim Empfang (entweder ganz neu oder vorher optional) • [Hinzufügen von neuen Daten beim Senden, für unflexible Clients] direkt aus der Praxis

Slide 8

Slide 8 text

8 direkt aus der Praxis

Slide 9

Slide 9 text

9 direkt aus der Praxis

Slide 10

Slide 10 text

10 direkt aus der Praxis

Slide 11

Slide 11 text

11 direkt aus der Praxis

Slide 12

Slide 12 text

12 direkt aus der Praxis

Slide 13

Slide 13 text

13 direkt aus der Praxis

Slide 14

Slide 14 text

14 • Mittels externer Bibliothek • NuGet: Microsoft.AspNetCore.Mvc.Versioning • GitHub: https://github.com/microsoft/aspnet-api-versioning • Hinweis • Paket stammt nicht vom ASP.NET Core Team • Nicht im aspnet/AspNetCore Repository • Kein offizielles von Microsoft supportetes Paket • Gewartet von einem Microsoft Entwickler aus dem Bing-Team direkt aus der Praxis

Slide 15

Slide 15 text

15 • Version • [Version Group.].[-Status] • [.[.Minor]][-Status] • Version Group • YYYY-MM-DD • Beispiele: • 1.0 • 2.1-RC1 • 2019-11-07.1 • 2019-11-07.2.1-Alpha direkt aus der Praxis

Slide 16

Slide 16 text

16 • Version kann festgelegt warden • Auf einem Controller • Auf einer einzelnen Action • Ermöglicht • Einen Controller pro Version • Mehrere Action-Versionen auf einem Controller • Beliebig mischbar • Angefragte, aber nicht gefundene Version liefert einen 400 Bad Request • Default-Version kann optional konfiguriert werden • Es gibt viele weitere Konfigurations- und Anpassungsmöglichkeiten direkt aus der Praxis

Slide 17

Slide 17 text

17 ▪ ▪ ▪ ▪ ▪ direkt aus der Praxis

Slide 18

Slide 18 text

18 ▪ ▪ ▪ direkt aus der Praxis

Slide 19

Slide 19 text

19 direkt aus der Praxis

Slide 20

Slide 20 text

20 direkt aus der Praxis

Slide 21

Slide 21 text

21 direkt aus der Praxis

Slide 22

Slide 22 text

22 • Konfigurieren von API Versioning • Verwenden von HTTP Headern zur Versionsauswahl • Verwenden von URL Pfad zur Versionsauswahl • API Versionen als veraltet markieren direkt aus der Praxis

Slide 23

Slide 23 text

23 direkt aus der Praxis

Slide 24

Slide 24 text

24 direkt aus der Praxis

Slide 25

Slide 25 text

25 direkt aus der Praxis

Slide 26

Slide 26 text

26 direkt aus der Praxis

Slide 27

Slide 27 text

27 • Einbinden in existierendes Projekt • Endpunkte von Versionierung ausnehmen • Custom Header Versioning • Angeforderte Version im Code abfragen direkt aus der Praxis

Slide 28

Slide 28 text

28 Demo Einbinden in existierendes Projekt direkt aus der Praxis

Slide 29

Slide 29 text

29 Demo Endpunkte ausnehmen direkt aus der Praxis

Slide 30

Slide 30 text

30 Demo Custom Header Versioning direkt aus der Praxis

Slide 31

Slide 31 text

31 Demo Angeforderte Version ermitteln direkt aus der Praxis

Slide 32

Slide 32 text

32 direkt aus der Praxis

Slide 33

Slide 33 text

33 • API-Versionierung ist nicht immer notwendig • Es gibt verschiedene Arten der Versionsauswahl • There’s a NuGet for that • Allerdings nicht offiziell vom ASP.NET Core Team • Verwendung benötigt wenig Code • Aber etwas Gehirnschmalz bei der Planung direkt aus der Praxis