Hoppa till innehållet
ShopentlyLearn

Versionering och OpenAPI

Bygg mot det uttryckliga kontraktet /api/v1 och det nedladdningsbara OpenAPI-dokumentet.

API-version

API-version
Versionen i URL:en identifierar det publika API-kontraktet.
Engine-utgåva
Engine-versionen i OpenAPI identifierar den implementation som exporterade dokumentet. Den är inte resursens expected_version.
Resursversion
Behandla resursversioner som värden för samtidighetskontroll och hämta dem från aktuella svar.

OpenAPI

Hämta OpenAPI
  • Spara det hämtade kontraktet tillsammans med integrationens tester.
  • Kontrollera obligatoriska fält, tillåtna enum-värden och svarsscheman när du uppdaterar integrationen.