نسخه‌بندی
نسخهٔ API در مسیر آدرس مشخص می‌شود. این مستندات مربوط به HAPI v3 است که زیر /v3/HAPI ارائه می‌شود. نسخهٔ اصلی بعدی زیر پیشوند جدیدی خواهد آمد؛ بنابراین یکپارچه‌سازی شما تا وقتی خودتان تصمیم به مهاجرت نگیرید، کار می‌کند.
چه چیزهایی پایدار است#
در v3 فقط تغییرات سازگار با نسخه‌های قبل اعمال می‌کنیم: اندپوینت جدید، فیلد اختیاری جدید در درخواست و فیلد جدید در پاسخ اضافه می‌کنیم. در طول این نسخه هیچ فیلد موجودی را تغییر نام نمی‌دهیم یا حذف نمی‌کنیم و نوع هیچ فیلدی را عوض نمی‌کنیم.
| ممکن است | انجام نمی‌دهیم (در v3) |
|---|---|
| اندپوینت جدید اضافه کنیم. | اندپوینتی را حذف یا تغییر نام دهیم. |
| فیلد جدیدی به پاسخ اضافه کنیم. | فیلدی از پاسخ را حذف یا تغییر نام دهیم. |
| پارامتر اختیاری جدیدی به درخواست اضافه کنیم. | پارامتری را که قبلاً اختیاری بوده الزامی کنیم. |
| مقدار جدیدی به یک enum اضافه کنیم. | نوع یک فیلد را تغییر دهیم. |
کلاینت انعطاف‌پذیر بسازید#
چون ممکن است فیلدهای جدید ظاهر شوند، فیلدهای ناشناخته را نادیده بگیرید و به‌خاطر آن‌ها خطا ندهید، و فرض نکنید مجموعهٔ مقادیر enum بسته است. این‌طور هیچ افزودهٔ سازگاری یکپارچه‌سازی شما را خراب نمی‌کند.
مرجع اصلی، مشخصات API است.
مشخصات ماشین‌خوان OpenAPI همیشه با این مرجع منطبق است. آن را در کلاینت خود وارد (import) کنید تا تایپ‌ها را تولید کنید و همگام بمانید.
ویرایش این صفحه در گیت‌هابمشکلی دیدید؟ از پنل ← پشتیبانی خبرمان کنید.