همانطور که API تکامل می یابد، روش های جدید، پارامترها و منطق ظاهر می شود. برای اینکه کار مشتریان فعلی را مختل نکنید، از نسخه های API استفاده می شود. ما از چندین روش برای نسخه پشتیبانی می کنیم، به انتگرال ها اجازه می دهد از نسخه مورد نظر رابط بدون خطر برای عملکرد پایدار استفاده کنند.
این مهم است که هر دو در هنگام مقیاس پذیری پلت فرم و هنگام اجرای به روز رسانی، تست و یا خدمات مشتریان قدیمی.
روش های نسخه بندی
| روش ها | توضیحات و مزایا |
|---|---|
| نسخه در نشانی وب) «/v1/» ( | راه قابل فهم ترین و محبوب مناسب برای API REST است |
| هدر را بپذیرید | مثال: "Accept: application/vnd. API + JSON ؛ version = 2 '- داده ها را از نسخه جدا می کند |
| نام مستعار GraphQL/حوزههای نسخهبندی شده | نسخه های مختلف از طریق نام مستعار: 'userV1'، 'userV2' - مناسب برای مهاجرت تدریجی |
| نسخههای سطح طرحواره | نمودارها و ماژول های جداگانه در OpenAPI/Swagger برای هر نسخه |
چگونه اجرا می شود
ساختار API با '/v1/'، '/v2/' و مسیرهای مستقل
بررسی سرآیند «Accept» و «X-API-Version»
GraphQL از نامهای مستعار و طرحوارههای نسخهبندی شده پشتیبانی میکند ('userV1', 'userV2')
توانایی تست A/B نسخه های جدید بدون خطر برای تولید
ثبت تماس به هر نسخه برای تجزیه و تحلیل و مهاجرت
مزایای کسب و کار و ادغام
پشتیبانی از مشتریان قدیمی بدون کاهش سرعت
عملیات موازی API چند نسل
با خیال راحت پیاده سازی ویژگی های جدید بدون شکستن سازگاری به عقب
انعطاف پذیری برای مقیاس و ارتقاء زیرساخت
مهاجرت یکپارچه بین نسخه های کنترل شده و تحلیلی
جایی که بسیار مهم است
پلتفرمهایی با چندین مشتری خارجی
پروژه ها با رویکرد API-first و چرخه عمر طولانی
ادغام با بانک ها، ارائه دهندگان، شرکای B2B
سیستم هایی با مشتریان تلفن همراه یا IoT طولانی مدت
نسخه API پایه و اساس قابلیت اطمینان و انعطاف پذیری در ادغام است. صرف نظر از فرمت (REST، GraphQL یا gRPC)، ما اطمینان از توسعه امن رابط ها - بدون شکست، درگیری و از دست دادن سازگاری.