هنگامی که API به طور فعال در حال تحول است، مهم است که سازگاری بین نسخه ها حفظ شود و از شرایطی که یک تغییر تنها چندین ادغام مشتری را می شکند، جلوگیری شود. ما یک نسخه کامل از قراردادها را اجرا می کنیم که به شما امکان می دهد تغییرات را کنترل کنید و API ها را بدون خطر برای کاربران به روز کنید.
این در معماری میکروسرویس، ادغام B2B و محصولات API باز است که در آن مشتریان مختلف از نسخه های مختلف رابط استفاده می کنند.
چه ما در حال نسخه
| شیء | توضیحات محصول |
|---|---|
| مشخصات OpenAPI | نگه داشتن هر نسخه از اسناد و قرارداد |
| Endpoint'ы | اضافه کردن نسخه به URL ('/v1/'، '/v2/')، صرفه جویی در سازگاری با عقب |
| قراردادها (پیمان، Dredd) | رفع شرایط تعامل بین مشتری و سرور |
| مدل های داده | نظارت بر تغییرات در ساختار درخواست و پاسخ |
چگونه پیاده سازی می کنیم
پشتیبانی از چندین نسخه API به صورت موازی
نسخهبندی صریح در نشانیهای وب، سرآیندها، یا پارامترها
خودکار از هر نسخه قرارداد (پیمان، پستچی، شوخی، Dredd)
مشخصات نسخه در Git یا از طریق CI/CD
مستندات و تغییرات برای مشتریان در هر تغییر
مزایای استفاده از
تضمین ثبات یکپارچگی
توانایی انتشار ویژگی های جدید بدون خطر «شکستن» مشتریان
ساده سازی مهاجرت بین نسخه ها
پاک کردن تاریخچه تغییر و کنترل قرارداد
شفافیت برای تیم های توسعه داخلی و خارجی
جایی که بسیار مهم است
معماری میکروسرویس چند وابستگی
سیستم عامل های API عمومی یا B2B
سیستم های مالی و پرداخت با قراردادهای بلند مدت
برنامه های موبایل که به یک API پایدار وابسته هستند
نسخه قرارداد پایه و اساس پیش بینی و اعتماد به API ها است. ما فرایندهایی را پیاده سازی می کنیم که به شما امکان تغییر و توسعه API ها را بدون درد می دهد، در حالی که حفظ سازگاری و شفافیت برای همه احزاب.