API arenedes tekivad uued meetodid, parameetrid ja loogika. Et mitte häirida praeguste klientide tööd, kasutatakse API versioone. Me toetame mitmeid lähenemisviise versioonile, võimaldades integraatoritel kasutada soovitud versiooni liidese ilma stabiilse käitamise ohuta.
See on oluline nii platvormi skaalamisel kui ka uuenduste rakendamisel, testimisel või vanade klientide teenindamisel.
Versioonimeetodid
| Meetod | Kirjeldus ja hüvitised |
|---|---|
| Versioon URL-is („/v1/“) | Kõige arusaadavam ja populaarsem viis on mugav ÜLEJÄÄNUD API jaoks |
| Aktsepteeri päist | Näide: "Aktsepteeri: rakendus/vnd. api + json; versioon = 2 "- eraldab andmed versioonist |
| GraphQL teise nimega/versioneeritud väljad | Erinevad versioonid varjunimede kaudu: „,“, „,“ - mugav järkjärguliseks rändeks |
| Skeemi tasandi versioonid | Eraldi skeemid ja moodulid OpenAPI/Swagger iga versiooni |
Rakendamisviis
API struktuur „/v1/“, „/v2/“ ja sõltumatud marsruudid
„Accept“ ja „X-API-Version“ päiste kontrollimine
GraphQL toetab varjunimesid ja versiooniskeeme („italianV1“, „italianV2“)
Võime A/B katsetada uusi versioone, ilma et see ohustaks tootmist
Kõnede logimine igasse versiooni analüüsimiseks ja rändeks
Äri ja integraatori eelised
Toetada vanu kliente aeglustumata
Mitme põlvkonna API paralleelkäitamine
Ohutult rakendada uusi funktsioone murdmata tagurpidi ühilduvus
Paindlikkus infrastruktuuri mõõtmiseks ja ajakohastamiseks
Juhitavate ja analüütiliste versioonide vaheline sujuv migratsioon
Kus eriti oluline
Platvormid mitme välise kliendiga
API-esimese lähenemisviisiga ja pika elutsükliga projektid
Integratsioon pankade, teenuseosutajate, ettevõtjatevaheliste partneritega
Süsteemid pikaajaliste mobiil- või IoT-klientidega
API versioonid on usaldusväärsuse ja paindlikkuse alus integratsioonides. Olenemata formaadist (REST, GraphQL või gRPC) tagame liideste ohutu arengu - ilma tõrgete, konfliktide ja ühilduvuse kadumiseta.