Przejdź do treści
ShopentlyLearn

Wersjonowanie API i OpenAPI

Buduj integrację na jawnym kontrakcie /api/v1 i pliku OpenAPI dostępnym do pobrania.

Wersja API

Wersja API
Wersja w adresie URL identyfikuje publiczny kontrakt API.
Wydanie Engine
Numer wydania Engine w OpenAPI wskazuje implementację, która wyeksportowała dokument; nie jest to expected_version zasobu.
Wersja zasobu
Wersje zasobów biznesowych traktuj jako wartości do kontroli współbieżności i pobieraj je z aktualnych odpowiedzi.

OpenAPI

Pobierz OpenAPI
  • Przechowuj pobrany kontrakt wraz z testami integracji.
  • Przy aktualizacji sprawdzaj wymagane pola, wartości enum i schematy odpowiedzi.