ตัวสร้าง JSON Schema

อนุมานและสร้าง JSON Schema มาตรฐานโดยอัตโนมัติจากข้อมูลตัวอย่าง JSON

เกี่ยวกับ ตัวสร้าง JSON Schema — คู่มือการใช้งาน

หมวดหมู่: DevOps และมาตรฐาน ประมวลผลบนเบราว์เซอร์ 100%

เครื่องมือสร้าง JSON Schema (JSON Schema Generator) อนุมานข้อกำหนดมาตรฐาน JSON Schema จากตัวอย่างข้อมูลเพย์โหลด JSON ได้โดยตรง รองรับมาตรฐานทั้ง Draft-07, Draft 2019-09 และ Draft 2020-12

ระบบจะวิเคราะห์โครงสร้างข้อมูลเพื่อตรวจหาชนิดข้อมูลพื้นฐาน (string, integer, number, boolean, array, object, null) และตรวจจับรูปแบบเชิงความหมาย เช่น date-time, email และ uri สามารถปรับแต่งช่องทำเครื่องหมายของพร็อพเพอร์ตี้ `required` และคัดลอกโค้ดสคีมาที่สะอาดเรียบร้อยได้ในคลิกเดียว

#json #schema #generate #validation #typescript

คุณสมบัติและความสามารถหลัก

  • อนุมานนิยาม JSON Schema ที่ถูกต้องตามมาตรฐานจากอ็อบเจกต์และอาร์เรย์ JSON ใดๆ
  • แยกแยะความแตกต่างระหว่างจำนวนเต็ม (integers), ตัวเลขทศนิยม (floating-point numbers) และชนิดข้อมูลพื้นฐานอื่นๆ ได้อย่างแม่นยำ
  • ตรวจหารูปแบบเชิงความหมายด้วยระบบฮิวริสติก รวมถึง ISO date-time, email และ uri
  • กล่องกาเครื่องหมายแบบเห็นภาพเพื่อเปิด/ปิดข้อจำกัด `required` บนพร็อพเพอร์ตี้ พร้อมการคัดลอกทันที

วิธีใช้งาน

  1. 1

    วางตัวอย่างเพย์โหลด JSON ของคุณลงในช่องป้อนข้อมูลทางด้านซ้าย

  2. 2

    คลิก Generate เพื่อวิเคราะห์ชนิดของพร็อพเพอร์ตี้และความลึกของโครงสร้างโดยอัตโนมัติ

  3. 3

    เปิด/ปิดแฟล็กฟิลด์ `required` ตามต้องการ จากนั้นคัดลอก JSON Schema ที่สร้างขึ้น

ตัวอย่างการใช้งานทั่วไป

  • → สร้างสคีมาสัญญาจากตัวอย่างการตอบกลับของ API ที่มีอยู่ระหว่างการทดสอบการเชื่อมต่อระบบ (integration testing)
  • → เตรียมสคีมาต้นทางสำหรับเครื่องมืออย่าง `json-schema-to-typescript`
  • → บังคับใช้ข้อจำกัดเชิงโครงสร้างบนเพย์โหลดของอีเวนต์ในระบบบัสข้อความแบบอะซิงโครนัส (asynchronous message bus)

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

คำถามที่พบบ่อยและความเป็นส่วนตัว

เครื่องมือนี้จัดการกับอาร์เรย์ที่มีอ็อบเจกต์ซึ่งมีพร็อพเพอร์ตี้ต่างกัน (heterogeneous) อย่างไร?

ระบบจะรวมพร็อพเพอร์ตี้ของทุกอ็อบเจกต์ภายในอาร์เรย์เข้าด้วยกันเพื่อสร้างเป็นสคีมาอ็อบเจกต์เดียวที่สามารถตรวจสอบความถูกต้องของทุกไอเท็มตัวอย่างได้

ฉันจะตรวจสอบความถูกต้องของเพย์โหลดเทียบกับสคีมาที่สร้างขึ้นได้อย่างไร?

คุณสามารถใช้ไลบรารีอย่าง `ajv` ในสภาพแวดล้อม Node.js หรือเบราว์เซอร์ โดยคอมไพล์สคีมาด้วย `const validate = ajv.compile(schema)` แล้วเรียกใช้งาน `validate(data)`