Major Version in der URL
Warum machen wir das?
In der API URL muss in die Major Version der API enthalten sein, um die API Version der Umgebung darzustellen. Siehe bspw.:
- https://apisyouwonthate.com/blog/api-versioning-has-no-right-way
- https://nordicapis.com/everything-you-need-to-know-about-api-versioning/
Mit dem Release der API 1.0 soll es eine V1 oder eine ähnliche Bezeichnung der inkludiert werden.
Relevante Links
Akzeptanzkriterien
Funktionale Anforderungen
- Hinter dem Hostbestandteil ist eine Versionsangabe der Major API Version (bspw. v1)
- Ist in geeigneter über die Spec dokumentiert (https://swagger.io/docs/specification/api-host-and-base-path/)
Nicht-funktionale Anforderungen
Definition of Done
- Dokumentation:
- API-Changes sind für Konsumenten der API dokumentiert
- Prozessänderungen sind für Konsumenten der API dokumentiert
- Code:
- Code Qualität & Formatierung eingehalten
- Commits orientieren sich an Conventional Commits
- Bei neuen Dateien sind Lizenz- und Urheberrechtshinweise gemäs der REUSE-Spezifikation vorhanden
- Leistung:
- Code ist in einer Testinstanz deployt
- Es gibt keine bekannten Bugs
- Testen:
- Alle funktionale Anforderungen sind durch Testfälle abgedeckt
Kann die Story umgesetzt werden? (Definition Ready)
- Ist für jeden Beteiligten klar verständlich
- Ist geschätzt
- Hat Akzeptanzkriterien
- Von der API-Änderung betroffene Softwareartefakte sind im Durchführungsplan identifiziert
Durchführungsplan
Betroffene Softwareartefakte
-
Zustelldienst (
- Self-Service-Portal
- OAuth Dienst
- Token Validator / API-Gateway
- Software Tools und SDKs für Entwickler
Umsetzungsschritte
- ...
- ...
- ...