API жигердүү өнүгүп жатканда, бир өзгөрүү кардарлардын интеграциялардын ондогон сындырып турган жагдайларга жол бербөө жана нускалардын ортосундагы шайкештикти сактоо маанилүү. Биз өзгөрүүлөрдү көзөмөлдөөгө жана колдонуучулар үчүн тобокелчиликсиз APIди акырындык менен жаңылоого мүмкүндүк берүүчү келишимдердин толук версияларын ишке ашырабыз.
Бул микросервис архитектурасында, B2B интеграциясында жана ар кандай кардарлар интерфейстин ар кандай версияларын колдонгон ачык API продуктыларында өтө маанилүү.
Биз эмнени версиялайбыз
| Объект | Сүрөттөө |
|---|---|
| OpenAPI өзгөчөлүктөрү | Документтердин жана келишимдин ар бир версиясын сактайбыз |
| Endpoint'ы | URL версияларын кошуу ('/v1/', '/v2/'), backward compatibility сактоо |
| Келишимдер (Pact, Dredd) | Кардар менен сервердин ортосундагы өз ара аракеттенүү шарттарын бекитүү |
| Маалыматтар моделдери | Суроо-талаптын жана жооптун түзүмүндөгү өзгөрүүлөрдү көзөмөлдөө |
Биз кантип ишке ашырабыз
Параллелдүү бир нече API версияларын колдоо
URL, аталыштарда же параметрлерде версияны ачык көрсөтүү
Контракттардын ар бир нускасын автотестирлөө (Pact, Postman, Jest, Dredd)
Git же CI/CD аркылуу өзгөчөлүктөрүн чыгаруу
Ар бир өзгөрүүдө кардарлар үчүн документтер жана changelog
Артыкчылыктары
Интеграциянын кепилденген туруктуулугу
Кардарларды "сындыруу" коркунучу жок жаңы чыпкаларды чыгаруу мүмкүнчүлүгү
Версиялар ортосундагы миграцияны жөнөкөйлөтүү
Өзгөрүүлөрдүн так тарыхы жана контракттарды көзөмөлдөө
Тышкы жана ички иштеп чыгуу командаларынын ачыктыгы
Кайда өзгөчө маанилүү
Көптөгөн көз карандылыктар менен микросервис архитектурасы
Коомдук же B2B API менен аянтчалар
Узак мөөнөттүү контракттары бар финансылык жана төлөм системалары
Туруктуу API көз каранды мобилдик тиркемелер
Келишимдерди версиялоо - бул APIде алдын ала билүүнүн жана ишенимдин негизи. Биз бардык тараптар үчүн шайкештикти жана ачык-айкындуулукту сактап, оорутпай API өзгөртүүгө жана өнүктүрүүгө мүмкүндүк берген процесстерди киргизип жатабыз.