วิธีใช้ JSON Schema ตรวจสอบข้อมูลของคุณ
JSON Schema คืออะไร?
JSON Schema คือรูปแบบมาตรฐานที่ใช้ในการอธิบายโครงสร้าง ฟิลด์ที่จำเป็น และชนิดของค่าภายในข้อมูล JSON ของคุณ เปรียบเสมือนสัญญาหรือแบบแปลนที่กำหนดว่าข้อมูล JSON ที่ถูกต้องควรมีลักษณะอย่างไร JSON Schema เขียนในรูปแบบ JSON ทำให้อ่านได้ทั้งโดยเครื่องและแก้ไขได้ง่าย
ทำไมจึงต้องตรวจสอบด้วย Schema?
- ป้องกันข้อผิดพลาดโดยการจับข้อมูลที่ไม่ถูกต้องหรือขาดหายก่อนที่จะก่อให้เกิดปัญหา
- รักษาความสอดคล้องของข้อมูลระหว่างทีม แอปพลิเคชัน หรือ API ต่างๆ
- สร้างเอกสารโดยอัตโนมัติจากสคีมา
- ช่วยให้โปรแกรมแก้ไขและเครื่องมือต่างๆ สามารถเติมข้อความและช่วยเหลือแบบอินไลน์ได้ดีขึ้น
ตัวอย่างง่ายๆ: สคีมาพื้นฐาน
นี่คือตัวอย่างวัตถุ JSON เบื้องต้น พร้อมกับสคีมาขั้นต่ำที่ตรวจสอบโครงสร้างของมัน:
{
"name": "Alice",
"age": 30
}
{
"type": "object",
"properties": {
"name": { "type": "string" },
"age": { "type": "number" }
},
"required": ["name", "age"]
}
สคีมานี้กำหนดให้วัตถุต้องมีฟิลด์ 'name' เป็นประเภทสตริง และ 'age' เป็นประเภทตัวเลข
วิธีเขียนสคีมาแบบกำหนดเอง
คุณสามารถกำหนดกฎขั้นสูงในสคีมาของคุณ เช่น จำกัดค่าของฟิลด์ กำหนดวัตถุซ้อน หรือกำหนดค่าต่ำสุด/ค่าสูงสุดตัวเลข ตัวอย่างนี้ใช้ตรวจสอบอาร์เรย์ของสินค้าต่างๆ:
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string" },
"price": { "type": "number", "minimum": 0 },
"tags": {
"type": "array",
"items": { "type": "string" }
}
},
"required": ["id", "price"]
}
}
การใช้ JSONValidator.dev เพื่อตรวจสอบ Schema
- วางข้อมูล JSON ของคุณในโปรแกรมแก้ไขหลัก
- วาง JSON Schema ของคุณในโปรแกรมแก้ไขสคีมาด้านล่าง
- คลิกที่ ตรวจสอบ JSON กับสคีมานี้
- ทบทวนผลการตรวจสอบ พร้อมไฮไลท์และอธิบายข้อผิดพลาดหากมี
การแก้ไขปัญหาข้อผิดพลาดการตรวจสอบ Schema
สาเหตุทั่วไปของข้อผิดพลาดตรวจสอบได้แก่:
- ข้อมูลขาดฟิลด์ที่จำเป็น
- ชนิดของค่าข้อมูลไม่ตรงกับสคีมา (เช่น สตริงกับตัวเลข)
- สคีมาไม่ถูกต้องหรือมีข้อผิดพลาดการพิมพ์
สรุป
การตรวจสอบด้วย JSON Schema เป็นวิธีที่ทรงพลังในการทำให้ข้อมูลของคุณแข็งแรงและปราศจากข้อผิดพลาด ลองสร้างสคีมาของคุณเองด้วย เครื่องสร้าง JSON Schema ฟรีของเรา และตรวจสอบข้อมูลของคุณแบบเรียลไทม์!