Softonic

ตัวตรวจสอบสเปค OpenAPI ออนไลน์

ขั้นตอน 1 / 2
ถัดไป

วางสเปค OpenAPI หรือ Swagger ด้านบนเพื่อดูรายการข้อผิดพลาดและคำเตือน หน้านี้อธิบายความหมายของแต่ละข้อความและวิธีแก้ไข เพื่อให้คุณเปลี่ยนจากรายงานสีแดงเป็นรายงานที่สะอาดได้อย่างรวดเร็ว ข้อผิดพลาดทำให้เอกสารไม่ถูกต้อง ส่วนคำเตือนไม่ทำให้เป็นเช่นนั้น

วิธีตรวจสเปคและดำเนินการตามรายงาน

  1. 1

    วางสเปค

    วางเอกสารในรูปแบบ JSON หรือ YAML ลงในช่องกรอก

  2. 2

    เปิดผลลัพธ์

    ไปยังขั้นตอนผลลัพธ์เพื่อดูข้อความว่าถูกต้อง หรือรายการข้อผิดพลาด

  3. 3

    จับคู่แต่ละข้อความ

    ค้นหาข้อความในตารางด้านล่างแล้วนำการแก้ไปใช้กับไฟล์ต้นฉบับ

  4. 4

    วางใหม่อีกครั้ง

    รันซ้ำจนไม่มีข้อผิดพลาดเหลือ แล้วตัดสินใจว่าคำเตือนใดควรแก้

การอ่านข้อความข้อผิดพลาด

ข้อความ ความหมาย วิธีแก้
Could not parse as JSON or YAML. ข้อความอ่านไม่ได้ทั้งในรูปแบบ JSON และ YAML แก้ไวยากรณ์: เครื่องหมายจุลภาคเกิน การย่อหน้าผิด หรือวงเล็บที่ไม่ได้ปิด
Missing ‘openapi’ or ‘swagger’ version field. ไม่มีคีย์เวอร์ชันระดับบนสุด เพิ่ม openapi: 3.0.3 หรือ swagger: "2.0"
Missing ‘info’ object. ไม่มีส่วน info เพิ่ม info ที่มี title และ version
info.title is required. info ไม่มี title เพิ่ม title ใต้ info
info.version is required. info ไม่มี version เพิ่ม version ใต้ info (เวอร์ชันของ API คุณ)
Missing ‘paths’ object. ไม่มีส่วน paths เพิ่ม paths แม้จะว่างในตอนแรกก็ได้

ข้อผิดพลาดคือสิ่งที่ตัดสินว่าเอกสารถูกต้องหรือไม่ ให้แก้ทุกข้อผิดพลาดก่อน

การอ่านคำเตือน

ข้อความ ความหมาย วิธีแก้
Path ‘x’ should start with ‘/’. คีย์ใต้ paths ไม่ได้ขึ้นต้นด้วยเครื่องหมายทับ เปลี่ยนชื่อเป็น /x
Unknown method ‘x’ on /path. คีย์ใต้พาธไม่อยู่ในรายการที่รู้จัก ตรวจว่าพิมพ์ผิดหรือไม่ หรือเพิกเฉยหากเป็นส่วนขยายที่ตั้งใจใส่ไว้หรือ trace

รายการที่รู้จักคือ get, post, put, patch, delete, head, options, parameters, summary, description และ servers ส่วนขยายของผู้จำหน่ายที่ขึ้นต้นด้วย x- ไม่อยู่ในรายการนี้ จึงแสดงเป็นคำเตือนด้วยเช่นกัน

สิ่งที่การตรวจออนไลน์บอกคุณไม่ได้

รายงานครอบคลุมเฉพาะโครงสร้าง ไม่ได้ตามลิงก์ $ref ไม่ได้ตรวจนิยามสคีมา และไม่ได้ระบุค่า operationId ที่หายไป ให้มองว่าการผ่านการตรวจคือการยืนยันว่าไฟล์มีรูปร่างเหมือนเอกสาร OpenAPI และใช้ลินเตอร์ฉบับเต็มก่อนเผยแพร่เอกสารหรือสร้างโค้ดไคลเอนต์

เคล็ดลับในการจัดการรายงานที่ยาว

เริ่มจากด้านบนสุด ข้อผิดพลาดการแยกวิเคราะห์หมายความว่าผลอื่น ๆ ไม่น่าเชื่อถือ จึงควรแก้ก่อน ต่อมาจัดการฟิลด์ระดับบนสุดที่หายไป เพราะเพิ่มได้รวดเร็ว หลังจากนั้นจึงค่อยดูคำเตือนของพาธ หลังทุกรอบการแก้ไข ให้วางไฟล์ทั้งไฟล์แทนที่จะวางเพียงบางส่วน เพราะการตรวจต้องการเอกสารทั้งฉบับเพื่อหา info และ paths รายงานที่ไม่มีข้อผิดพลาดและมีคำเตือนที่ตั้งใจไว้บางรายการเป็นจุดจบที่ปกติและยอมรับได้

คำถามที่พบบ่อย

ข้อผิดพลาดหมายความว่าเอกสารถูกระบุว่าไม่ถูกต้อง ส่วนคำเตือนชี้ประเด็นที่ควรดูอีกครั้ง เช่น พาธที่ไม่ได้ขึ้นต้นด้วยเครื่องหมายทับ แต่ไม่เปลี่ยนผลลัพธ์ที่ถูกต้อง

ไม่จำเป็น หมายความเพียงว่าโครงสร้างระดับบนสุดครบถ้วน สคีมา การอ้างอิง และการตอบกลับยังไม่ได้รับการตรวจ

คีย์ใต้พาธจะถูกเทียบกับรายการเมธอด HTTP ที่กำหนดไว้ตายตัว และฟิลด์บางส่วนของรายการพาธ คีย์ x- ไม่อยู่ในรายการนี้ จึงถูกแจ้งเป็นคำเตือน คุณสามารถคงไว้ได้

ไม่ ข้อผิดพลาดจะเรียงตามลำดับของการตรวจ คือ ฟิลด์เวอร์ชันก่อน จากนั้นคือ info แล้วจึงเป็น paths ไม่มีหมายเลขบรรทัดในผลลัพธ์

เครื่องมือที่เกี่ยวข้อง

ตัวสร้างการตั้งค่า Webpack

สร้าง webpack.config.js สำหรับ webpack 5 ทั้งแบบ JavaScript ล้วน React หรือ Vue พร้อม TypeScript, Babel, CSS หรือ Sass, รูปภาพ, HtmlWebpackPlugin, เซิร์ฟเวอร์สำหรับพัฒนา และคำสั่ง npm install

เครื่องแปลงฐานตัวเลข

แปลงตัวเลขระหว่างฐานสอง ฐานแปด ฐานสิบ ฐานสิบหก และฐานกำหนดเองตั้งแต่ 2 ถึง 36 พร้อมการแยกค่าประจำหลัก

ตัวแปลง Timestamp

แปลง timestamp ของ Unix ในหน่วยวินาทีหรือมิลลิวินาทีเป็นวันที่ที่อ่านง่ายในเขตเวลา UTC และเขตเวลาหลัก และแปลงวันที่กลับเป็นค่า epoch

อ้างอิงตัวอักษร HTML

รายการที่สามารถค้นหาได้ขององค์ประกอบ HTML พร้อมรหัสชื่อและรหัสตัวเลข รวมถึงฟังก์ชันสำเนาด้วยคลิกเดียวสำหรับตัวอักษรพิเศษและสัญลักษณ์ต่างๆ

ตารางอ้างอิง ASCII

ตาราง ASCII ครบตั้งแต่ 0 ถึง 127 พร้อมค่าเลขฐานสิบ ฐานสิบหก ฐานแปด ฐานสอง และรูปแบบการอ้างอิงอักขระแบบตัวเลขของ HTML รวม NUL, LF และ DEL

เครื่องสุ่มที่อยู่

สร้างระเบียนคล้ายที่อยู่ 1–20 รายการสำหรับแบบจำลองและการทดสอบ ด้วยรูปแบบประเทศแบบย่อ

เครื่องมือนี้มีให้บริการในภาษาอื่น

คู่มือและกรณีการใช้งาน