OpenAPITools/openapi-diff
این ابزار برای مقایسهٔ دو فایل مشخصات OpenAPI (مانند swagger.json یا swagger.yaml) طراحی شده است. ️
کاربرد:
این ابزار تغییرات بین دو نسخه از API را تشخیص میدهد و نشان میدهد که آیا تغییرات سازگار با نسخههای قبلی هستند یا خیر. بهطور خاص برای جلوگیری از شکستن تغییرات (breaking changes) در APIهای عمومی مفید است.
در چه شرایطی بهتره استفاده شود؟
وقتی داری نسخههای مختلف API رو مدیریت میکنی، توی محیطهای توسعهٔ تیمی، یا میخوای قبل از استقرار تغییرات، مطمئن بشی که APIهای قبلی همچنان کار میکنند. همچنین میتونه توی CI/CD پایپلاینها برای بررسی خودکار تغییرات استفاده شود.
چند مثال از موارد استفاده:
- تشخیص اینکه آیا حذف یک endpoint باعث شکستن کلاینتهای قبلی میشه؟
- بررسی اینکه آیا افزودن یک فیلد اختیاری به response مشکلی ایجاد نمیکنه؟
- گزارش خودکار تغییرات در مستندات API بین نسخهها
- استفاده در تستهای ادغام (integration tests) برای جلوگیری از breaking changes
- ##API
- ##OpenAPI
- ##Breaking
- ##CI
- ##API
- ##Swagger
- ##Version
- ##DevOps
- ##Microservices
- ##Backward