Ga naar de inhoud
AchaduDevelopers
Operationele APIGa naar website
Dashboard
Achadu/Developers/Versiebeheer

Compatibele evolutie, expliciete migraties.

De hoofdversie staat in de URL. Additieve wijzigingen worden in v1 doorgevoerd zonder clients te verbreken; Incompatibele wijzigingen vereisen een nieuwe versie en een nieuw migratievenster.

Wat zou er kunnen veranderen in v1

Nieuwe eindpunten

Er kunnen aanvullende bewerkingen en functies worden gepubliceerd.

Nieuwe optionele velden

Klanten moeten onbekende eigenschappen in reacties negeren.

Nieuwe evenementen

Aan abonnementen met * kunnen typen worden toegevoegd aan de catalogus.

Nieuwe waarden

Open enums kunnen gedocumenteerde statussen of providers verkrijgen.

Wat vereist een nieuwe versie

Verwijderen of hernoemen

Bestaand eindpunt, veld of waarde verdwijnt niet stilletjes.

Verander de betekenis

Incompatibele semantiek, eenheid of formaat vereist een nieuw contract.

Maak het verplicht

Een optioneel veld wordt binnen dezelfde versie niet verplicht.

Wijzig authenticatie

Incompatibele autorisatiewijzigingen krijgen hun eigen migratie.

Afschrijvingscyclus

1
Aankondiging

Verandering gaat de geschiedenis in met vervanging en impact.

2
Migratie

De twee vormen bestaan naast elkaar tijdens het geïnformeerde venster.

3
Let op in productie

Documentatie en antwoorden identificeren het beëindigde contract.

4
Sluiten

Afhaling vindt uitsluitend plaats op de aangekondigde datum.

Hoe u een veerkrachtige cliënt schrijft

Negeer onbekende antwoordvelden.
Behandel onbekende opsommingen als een niet-ondersteunde geldige status.
Wees niet afhankelijk van de volgorde van JSON-eigenschappen.
Gebruik de versie van de URL, niet een versie die is afgeleid van de SDK.
Houd de geschiedenis bij voordat u een gegenereerde klant bijwerkt.