เทียบ OpenAPI Spec
เทียบ OpenAPI/Swagger spec สองตัว รายงาน endpoint ที่เพิ่ม ลด และแก้ไข พร้อม flag breaking changes ทันทีในเบราว์เซอร์
Loading tool...
เทียบ OpenAPI Spec คืออะไร?
OpenAPI Spec Diff Checker เทียบ OpenAPI/Swagger JSON spec สองตัวแบบราย endpoint รายงาน method ที่เพิ่มและถูกลบพร้อม flag breaking change ผลลัพธ์เป็นรายงานที่เรียงแล้วคำนวณทันทีในเบราว์เซอร์
ประโยชน์หลัก
- เทียบระดับ endpoint พร้อม HTTP method badge
- flag breaking change สำหรับ endpoint ที่ถูกลบ
- ผลลัพธ์เรียงตามตัวอักษร อ่านง่าย
- เป็นส่วนตัวโดยดีไซน์ - spec ไม่ออกจากเครื่อง
กรณีการใช้งาน
- •รีวิวการเปลี่ยนแปลง API ก่อน release
- •ยืนยันว่าการ refactor ไม่ทำลาย contract
- •สร้าง changelog จาก diff ของ spec
- •ตรวจ backward compatibility ระหว่างเวอร์ชัน
- •audit API ของบุคคลที่สาม
เทียบ OpenAPI Spec
- วาง spec A: วาง OpenAPI JSON เวอร์ชันเก่าลงใน editor ด้านซ้าย
- วาง spec B: วาง OpenAPI JSON เวอร์ชันใหม่ลงใน editor ด้านขวา
- อ่าน diff: endpoint ที่เพิ่มและลดจะแสดงเรียงตามตัวอักษรพร้อม HTTP method badge
- ระวัง breaking changes: endpoint ที่ถูกลบจะถูก flag เป็น breaking change ที่ต้องอัปเดต client-side
คุณสมบัติหลัก
- เทียบ spec แบบราย endpoint
- ตรวจจับ method ที่เพิ่ม ลด และแก้ไขต่อ path
- flag breaking change เมื่อ endpoint หรือ method ถูกลบ
- ผลลัพธ์เรียงตามตัวอักษร อ่านรายงานง่าย
- เทียบสดทุกครั้งที่พิมพ์
- client-side ทั้งหมด - spec ไม่ออกจากเครื่อง
คำถามที่พบบ่อย
รองรับ spec รูปแบบไหน?
รองรับ OpenAPI/Swagger แบบ JSON (OpenAPI 2.0, 3.0, 3.1) ผู้ใช้ YAML ควรแปลงเป็น JSON ก่อนด้วย YAML-to-JSON converter
อะไรถือเป็น breaking change?
endpoint หรือ HTTP method ที่มีใน spec A แต่ถูกลบใน spec B Breaking changes ต้องอัปเดต client-side และควรจัดการเรื่อง version อย่างระวัง
เทียบ schemas และ parameters ด้วยหรือไม่?
เทียบระดับ endpoint (path + method) ส่วน schema และ parameter ภายในแต่ละ endpoint อยู่ในแผนพัฒนาเวอร์ชันถัดไป
spec ของฉันถูกอัปโหลดหรือไม่?
ไม่ ทั้งสอง spec ถูก parse และเทียบในเบราว์เซอร์ล้วน โครงสร้าง API ของคุณไม่เคยออกจากเครื่อง