เครื่องมือดูเอกสาร OpenAPI
ดูและตรวจสอบแบบสแตติกสำหรับเอกสาร OpenAPI 3.0/3.1 JSON หรือ YAML ภายในเครื่อง โดยไม่ส่งคำขอตัวอย่าง
วิธีใช้โปรแกรมดูเอกสาร OpenAPI
OpenAPI โปรแกรมดูเอกสารจะประมวลผลข้อมูลนำเข้าในเบราว์เซอร์ปัจจุบันเท่านั้น โดยจะไม่อัปโหลด เชื่อมต่อเครือข่าย หรือบันทึกข้อมูลผู้ใช้
ป้อนเนื้อหา
วางหรือโหลดเอกสาร OpenAPI 3.0/3.1 JSON/YAML
เลือกวิธีดำเนินการ
เรียกดู paths, การดำเนินการ, พารามิเตอร์, เนื้อหาคำขอ, การตอบกลับ และการอ้างอิงภายในเครื่อง พร้อมดูปัญหาแบบสแตติก
ตรวจสอบและส่งออก
คัดลอกสรุปเอกสารหรือส่งออกผลการตรวจสอบ โดยจะไม่ดำเนินการคำขอ API ใด ๆ
ข้อจำกัดและข้อควรระวัง
- แยกวิเคราะห์เฉพาะเอกสารภายในเครื่องและ $ref ภายในเครื่องเท่านั้น การอ้างอิงระยะไกลและการดำเนินการตามคำขอถูกห้าม
- โปรแกรมดูนี้ไม่ใช่ตัวตรวจสอบข้อกำหนด OpenAPI ฉบับสมบูรณ์ และไม่สามารถยืนยันได้ว่าอินเทอร์เฟซใช้งานได้จริง
- เครื่องมือนี้ให้เฉพาะผลการประมวลผลเบื้องต้นภายในเครื่องเท่านั้น ส่วนการกำหนดค่าที่สำคัญ คีย์ เอกสาร และเนื้อหาที่เผยแพร่ยังคงต้องตรวจสอบในสภาพแวดล้อมเป้าหมาย
คำถามที่พบบ่อย
อินพุตจะถูกอัปโหลดไปยังเซิร์ฟเวอร์หรือไม่?
ไม่ หน้าเว็บใช้เฉพาะหน่วยความจำของเบราว์เซอร์ ไฟล์ในเครื่อง API และทรัพยากรภายในเครื่องที่มีให้พร้อมกับเว็บไซต์เท่านั้น
ระบบจะเรียกใช้อินเทอร์เฟซของฉันตามเอกสารหรือไม่
ไม่ เครื่องมือนี้สร้างเฉพาะโครงสร้างเอกสารภายในเครื่องและผลการตรวจสอบแบบคงที่เท่านั้น และไม่สร้างคำขอเครือข่าย
เหตุใดผลลัพธ์จึงยังต้องตรวจสอบด้วยตนเอง
ไวยากรณ์ในกรณีขอบเขต ข้อกำหนดเฉพาะภูมิภาค โปรแกรมอ่านของบุคคลที่สาม และสภาพแวดล้อมเป้าหมายที่ใช้ทำงานอาจแตกต่างกัน เครื่องมือนี้ไม่สามารถทดแทนการตรวจสอบขั้นสุดท้ายได้