وب‌سرویس مجید

پروژه aspnet-api-versioning

dotnet/aspnet-api-versioning

کاربرد:

این پروژه به تو امکان میده تا نسخه‌بندی API رو در برنامه‌های ASP.NET Web API، OData با ASP.NET Web API و همچنین ASP.NET Core به راحتی پیاده‌سازی کنی. ️ با استفاده از این کتابخانه، می‌تونی چندین نسخه از یک API رو همزمان مدیریت کنی و مطمئن بشی که کلاینت‌ها با توجه به نسخه‌ای که درخواست می‌کنن، پاسخ درست رو دریافت می‌کنن.

در چه شرایطی بهتره استفاده شود؟

وقتی که داری یک API عمومی یا داخلی توسعه می‌دی و نیاز داری تغییرات در آینده بدون شکستن سازگاری با نسخه‌های قبلی اعمال شود، این ابزار عالیه. مخصوصاً در پروژه‌های بزرگ یا سرویس‌هایی که توسط چندین تیم یا مشتری استفاده می‌شن، نسخه‌بندی API ضروریه.

چند مثال از موارد استفاده

اضافه کردن فیلد جدید به خروجی API بدون تأثیر روی کلاینت‌های قدیمی

تغییر منطق یک endpoint در نسخه جدید در حالی که نسخه قبلی هم فعال باقی بمونه

مدیریت نسخه‌های مختلف API از طریق URL، هدر یا query string

پشتیبانی از OData در کنار نسخه‌بندی در پروژه‌های داده‌محور

  • ##API
  • ##ASPNETCore
  • ##WebAPI
  • ##OData
  • ##DotNet
  • ##RESTful
  • ##BackEnd
  • ##Microservices
  • ##API
  • ##VersionControl