เครื่องมือตรวจสอบ JSON Schema

คีย์เวิร์ดที่รองรับ

แกนหลัก: type, enum, const, multipleOf, maximum, minimum, exclusiveMaximum, exclusiveMinimum, maxLength, minLength, pattern, maxItems, minItems, uniqueItems, maxContains, minContains, maxProperties, minProperties, required, dependentRequired

การประกอบ: allOf, anyOf, oneOf, not

ตัวปรับใช้: properties, patternProperties, additionalProperties, items, prefixItems, contains, propertyNames

เงื่อนไข: if, then, else, dependentSchemas

การอ้างอิง: $ref, $defs, $id, $anchor

รูปแบบ (พร้อมการตรวจสอบเมื่อเปิดใช้งาน): date-time, date, time, duration, email, hostname, ipv4, ipv6, uri, uuid, regex

ผลลัพธ์ข้อผิดพลาด

FAIL  /user/email        format            "not-an-email" is not a valid "email"
FAIL  /user/age          minimum           -3 is less than the minimum 0
FAIL  /orders/0/total    type              "42" is not of type "number"
FAIL  /                  required          missing required property "shippingAddress"

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

ความแตกต่างระหว่างดราฟต์ที่มักทำให้พลาด

ตั้งค่าดราฟต์ให้ถูกต้อง การตรวจสอบสคีมาดราฟต์ 04 ในฐานะดราฟต์ 2020-12 จะทำให้ตีความ id และรายละเอียดปลีกย่อยอื่นๆ ผิดพลาด

เวิร์กโฟลว์ทั่วไป

• การทดสอบสัญญา API: ก่อนการดีพลอย ให้รันสคีมา OpenAPI ที่สร้างหรืออัปเดตแล้วเทียบกับการตอบสนองตัวอย่างจริง
• การเสริมความแข็งแกร่งให้การกำหนดค่า: ตรวจสอบไฟล์กำหนดค่า YAML/JSON ทุกไฟล์ในขั้นตอน CI เทียบกับสคีมาก่อนการรวมโค้ด
• การรับข้อมูลเข้า: ปฏิเสธเพย์โหลดที่ไม่ตรงกับรูปแบบที่คาดไว้ตั้งแต่ต้น พร้อมข้อความแจ้งข้อผิดพลาดที่ชัดเจน

ข้อผิดพลาดที่พบบ่อย

• ลืมบังคับใช้ format โดยค่าเริ่มต้น เครื่องมือตรวจสอบส่วนใหญ่จะถือว่ารูปแบบที่ไม่รู้จักเป็นเพียงคำอธิบายประกอบเท่านั้น หากต้องการปฏิเสธอีเมลและวันที่ที่ไม่ถูกต้องจริงๆ ให้เปิดใช้การตรวจสอบรูปแบบอย่างเข้มงวด
• ใช้ oneOf มากเกินไป หากสองสาขาของ oneOf ทับซ้อนกัน เอกสารจะล้มเหลว (ต้องตรงกับเพียงสาขาเดียวเท่านั้น) ให้ใช้ anyOf หรือรูปแบบตัวจำแนกแทน
• สคีมาที่เข้มงวดด้วย additionalProperties: false การเพิ่มฟิลด์ทางเลือกใหม่จะกลายเป็นการเปลี่ยนแปลงที่ทำลายความเข้ากันได้ ควรละเว้นไว้ เว้นแต่คุณต้องการอ็อบเจ็กต์แบบปิดจริงๆ