เครื่องสร้างสคีมา JSON

เครื่องสร้างสคีมา JSON (JSON Schema Generator) จะเปลี่ยนตัวอย่างข้อมูล JSON ให้เป็นสคีมาที่พร้อมใช้สำหรับโปรแกรมตรวจสอบความถูกต้อง (validator) สำหรับใช้งานกับ API, เว็บฮุก (webhooks), ไฟล์การตั้งค่า (configuration files), ไปป์ไลน์ข้อมูล (data pipelines) และเอกสารประกอบการใช้งาน เพียงวางวัตถุ JSON, อาร์เรย์ หรือข้อมูล NDJSON ที่เป็นตัวแทน เลือกรูปแบบการคาดการณ์ แล้วเครื่องมือจะสร้างสคีมาที่มาพร้อมคุณสมบัติย่อย กฎเกณฑ์รายการอาร์เรย์ ค่าที่อนุญาตให้เป็นค่าว่าง ตัวอย่างข้อมูล และบันทึกสรุปแบบแยกทีละเส้นทางที่อ่านง่าย

ทำไมต้องใช้เครื่องสร้างสคีมา JSON จากตัวอย่างข้อมูล?

การเขียน JSON Schema ด้วยตัวเองช่วยให้ได้ข้อมูลที่แม่นยำแต่ทำได้ช้า โดยเฉพาะอย่างยิ่งเมื่อข้อมูลมีวัตถุซ้อนกัน อาร์เรย์ของระเบียน ฟิลด์ที่ไม่บังคับ และค่าที่ยอมรับเป็นค่าว่าง เครื่องสร้างนี้จะช่วยร่างโครงสร้างแรกเริ่มที่รวบรวมรูปแบบโครงสร้างตามที่พบบนข้อมูล JSON ของคุณ จากนั้นจะเน้นจุดที่ยังจำเป็นต้องใช้คนตรวจสอบซ้ำ ซึ่งมีประโยชน์อย่างยิ่งสำหรับการตรวจสอบคำขอ API (API request validation), สัญญาการตอบกลับ (response contracts), การทำงานกับ OpenAPI, ข้อมูลเว็บฮุก, สตรีมเหตุการณ์ (event streams) และสคีมาไฟล์ตั้งค่า

วิธีใช้งาน

1. วางวัตถุ JSON, อาร์เรย์ JSON หรือระเบียน NDJSON (newline-delimited JSON) ที่เป็นตัวแทนลงในโปรแกรมแก้ไขตัวอย่าง
2. เลือกเวอร์ชันโครงร่าง (draft) ของ JSON Schema และตัดสินใจว่าจะให้คาดการณ์ฟิลด์ที่จำเป็น, ตัวอย่าง, คำใบ้ enum, รูปแบบสตริง และกฎปิดวัตถุหรือไม่ ค่าเริ่มต้นคือ Draft 2020-12, ฟิลด์ที่จำเป็นตั้งเป็น พบในทุกวัตถุ, เปิดใช้การตรวจจับรูปแบบ, ตัวอย่าง และคำใบ้ enum, ส่วนกฎปิดวัตถุปิดอยู่ ชื่อสคีมาเริ่มต้นเป็น GeneratedSchema
3. คลิก สร้าง JSON Schema เพื่อคาดการณ์ประเภทข้อมูล, คุณสมบัติย่อย (nested properties), รายการอาร์เรย์, ฟิลด์ที่อนุญาตให้เป็นค่าว่าง และคำใบ้การตรวจสอบความถูกต้อง
4. ตรวจสอบแผนผังที่สร้างขึ้นเพื่อดูแต่ละเส้นทาง (path), ประเภทที่คาดการณ์, สถานะความจำเป็น, รูปแบบ และกฎก่อนนำสคีมาไปใช้งาน
5. คัดลอกสคีมาที่สร้างขึ้นแล้วนำไปปรับแต่งกฎการตรวจสอบความถูกต้องเฉพาะโดเมน เช่น ช่วงข้อมูลที่แน่นอน, รูปแบบ ID และ enum เฉพาะสำหรับธุรกิจ

สิ่งที่เครื่องสร้างคาดการณ์ให้คุณ

• ประเภทข้อมูลพื้นฐานของ JSON: object, array, string, number, integer, boolean และ null
• คุณสมบัติของวัตถุซ้อนกันและฟิลด์ที่จำเป็น โดยอิงตามสิ่งที่ปรากฏในทุกวัตถุที่ถูกตรวจพบ
• สคีมาของรายการอาร์เรย์ โดยการผสานรายการที่พบในตัวอย่างเข้าด้วยกัน
• รูปแบบสตริงทั่วไป รวมถึงอีเมล, URL, วันที่, วันที่-เวลา, UUID, IPv4 และ IPv6
• ตัวเลือกเสริม เช่น ตัวอย่างข้อมูล, คำใบ้ enum, ช่วงตัวเลขที่พบ และความยาวของสตริงที่พบ

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

เครื่องสร้างสคีมา JSON นี้ทำอะไรได้บ้าง?

มันจะอ่านตัวอย่าง JSON และสร้าง JSON Schema ที่อธิบายโครงสร้างข้อมูลที่พบ เครื่องสร้างนี้จะคาดการณ์คุณสมบัติของวัตถุ, อาร์เรย์, ประเภทข้อมูลพื้นฐาน (primitive types), ค่าที่ยอมรับเป็นค่าว่าง (nullable values), ตัวอย่าง, คำใบ้ enum, ฟิลด์ที่จำเป็น และรูปแบบสตริงทั่วไป

สคีมาที่สร้างขึ้นสามารถนำไปใช้ในสภาพแวดล้อมจริง (production) ได้ทันทีหรือไม่?

ควรใช้เป็นจุดเริ่มต้นที่ดีแล้วนำไปตรวจสอบซ้ำ ข้อมูลตัวอย่างไม่สามารถรู้กฎเกณฑ์ทางธุรกิจทั้งหมดได้ ดังนั้นคุณอาจยังจำเป็นต้องเพิ่มรูปแบบข้อความ (patterns), ช่วงข้อมูลที่แน่นอน, ค่า enum ที่อนุญาต, กฎของเวอร์ชัน และการตั้งค่า additionalProperties ที่เข้มงวดยิ่งขึ้น

รองรับเวอร์ชันโครงร่าง (draft) ใดของ JSON Schema บ้าง?

เครื่องมือนี้สามารถสร้างสคีมาสำหรับ Draft 2020-12, Draft 2019-09 และ Draft-07 ได้โดยการกำหนด URI ของ $schema โครงสร้างที่คาดการณ์ได้รับการออกแบบมาให้เข้ากันได้กับโปรแกรมตรวจสอบความถูกต้อง (validators) ทั่วไป

ฟิลด์ที่จำเป็นถูกคาดการณ์อย่างไร?

เมื่อเปิดใช้งานการคาดการณ์ฟิลด์ที่จำเป็น คุณสมบัติจะถูกทำเครื่องหมายว่าจำเป็น (required) ก็ต่อเมื่อคุณสมบัติต้นทางนั้นปรากฏอยู่ในทุกวัตถุที่พบในระดับชั้นนั้น สำหรับอาร์เรย์ของวัตถุ หมายความว่าฟิลด์นั้นจะต้องปรากฏในทุกรายการที่สุ่มตัวอย่าง

เครื่องมือนี้รองรับอาร์เรย์ของวัตถุและ NDJSON หรือไม่?

รองรับ อาร์เรย์ JSON ในระดับบนสุด (top-level) จะถูกประมวลผลเป็นสคีมาแบบอาร์เรย์ และระเบียนแบบแยกด้วยขึ้นบรรทัดใหม่ (NDJSON) จะถูกประมวลผลเป็นอาร์เรย์ของระเบียน โดยคุณสมบัติของรายการจะถูกผสานรวมจากตัวอย่างที่พบ