ตรวจสอบ OpenAPI
ตรวจสอบไฟล์ OpenAPI/Swagger specification (v2, v3) ตรวจสอบ syntax โครงสร้าง และแนวทางปฏิบัติที่ดีที่สุด ค้นหาข้อผิดพลาดและคำเตือน เครื่องมือที่จำเป็นสำหรับนักพัฒนา API
Loading tool...
ตรวจสอบ OpenAPI คืออะไร?
OpenAPI Validator ตรวจไฟล์ OpenAPI และ Swagger specification หาข้อผิดพลาด แนวทางปฏิบัติที่ดี และความเข้ากันได้ รองรับ v2 (Swagger) และ v3 (OpenAPI)
ประโยชน์หลัก
- ตรวจสอบ Spec
- ตรวจจับข้อผิดพลาด
- แนวทางที่ดี
- รองรับเวอร์ชัน
กรณีการใช้งาน
- •พัฒนา API
- •คุณภาพเอกสาร
- •ตรวจสอบ CI/CD
- •การกำกับดูแล API
วิธีตรวจสอบ OpenAPI Specifications
- อัปโหลดหรือวาง: อัปโหลดไฟล์ OpenAPI YAML/JSON หรือวางเนื้อหาลงในตัวแก้ไข
- รันการตรวจสอบ: คลิก "ตรวจสอบ" เพื่อเช็คข้อกำหนด เครื่องมือตรวจจับ OpenAPI 3.x หรือ Swagger 2.0 อัตโนมัติ
- ตรวจสอบข้อผิดพลาด: เช็คแผง error หา structural errors, ฟิลด์ที่จำเป็นที่ขาด และการอ้างอิงที่ไม่ถูกต้อง
- ตรวจสอบคำเตือน: จัดการคำเตือนเกี่ยวกับแนวทางปฏิบัติที่ดี ฟีเจอร์ที่เลิกใช้ และการกำหนดความปลอดภัย
- แก้ไขและตรวจสอบใหม่: ทำการเปลี่ยนแปลงเพื่อแก้ไข errors จากนั้นรันการตรวจสอบใหม่จนกว่า spec จะสะอาด
คุณสมบัติหลัก
- รองรับหลายเวอร์ชัน: ตรวจสอบทั้ง OpenAPI 3.x และ Swagger 2.0 specifications
- ตรวจสอบโครงสร้าง: ตรวจสอบฟิลด์ที่จำเป็น การซ้อนที่เหมาะสม และโครงสร้าง specification
- ตรวจสอบ Schema: ตรวจสอบ request/response schemas ตามมาตรฐาน JSON Schema
- ตรวจสอบการอ้างอิง: ตรวจจับลิงก์ $ref ที่เสียและการอ้างอิงแบบวงกลม
- Security Definitions: ตรวจสอบ security schemes และการตั้งค่า requirements
- แนวทางปฏิบัติที่ดี: เตือนเกี่ยวกับฟีเจอร์ที่เลิกใช้และแนะนำการปรับปรุง
- รายงานข้อผิดพลาดละเอียด: หมายเลขบรรทัด paths และคำอธิบายที่ชัดเจนสำหรับแต่ละข้อผิดพลาด