ตัวตรวจสอบความถูกต้อง JSON Schema

ตัวตรวจสอบ JSON Schema ทำงานอย่างไร

เครื่องมือนี้ทำอะไร

ตัวตรวจสอบ JSON Schema นี้จะตรวจสอบข้อมูล JSON เทียบกับ JSON Schema (draft-04, draft-06, draft-07 หรือ 2019-09) โดยรายงานว่าข้อมูลถูกต้องหรือไม่ และเมื่อไม่ถูกต้องจะแสดงพาธ คีย์เวิร์ด และข้อความของแต่ละข้อผิดพลาดเพื่อให้คุณแก้ไขข้อมูลหรือปรับสคีมาได้

กรณีการใช้งานทั่วไปของนักพัฒนา

นักพัฒนาใช้ตัวตรวจสอบ JSON Schema เพื่อทดสอบเพย์โหลดคำขอ/คำตอบของ API ตรวจสอบไฟล์คอนฟิก สร้างหรือดีบักการตรวจสอบแบบอิงสคีมาในโค้ด และทำให้แน่ใจว่า OpenAPI หรือรูปแบบอื่นที่ขับเคลื่อนด้วยสคีมาถูกต้อง นอกจากนี้ยังมีประโยชน์เมื่อสร้างฟอร์มหรือไปป์ไลน์ ETL ที่อาศัย JSON Schema

อินพุตสคีมาและข้อมูล

วางหรือโหลด JSON Schema ของคุณในพาเนลหนึ่ง และวางข้อมูล JSON ของคุณในอีกพาเนลหนึ่ง เครื่องมือนี้จะแยกวิเคราะห์ทั้งสองและทำการตรวจสอบ เวอร์ชันสคีมาที่รองรับจะถูกตรวจจับจากคีย์เวิร์ด "$schema" หาก JSON ในพาเนลใดพาเนลหนึ่งไม่ถูกต้อง ระบบจะแจ้งก่อนเริ่มการตรวจสอบ

ข้อผิดพลาดที่พบบ่อยและกรณีขอบ

ตรวจสอบให้แน่ใจว่าสคีมาเองเป็น JSON ที่ถูกต้องและใช้ URL ของ "$schema" ที่รองรับ ข้อมูลที่ว่างเปล่าหรือไม่ใช่อ็อบเจ็กต์อาจถูกต้องหรือไม่ถูกต้องขึ้นอยู่กับสคีมา (เช่น ฟิลด์ที่จำเป็น ข้อจำกัดของชนิดข้อมูล) ข้อผิดพลาดที่ซ้อนกันจะแสดงด้วยสัญกรณ์พาธ แก้ไขข้อผิดพลาดหนึ่งรายการแล้วรันใหม่เพื่อดูปัญหาที่เหลือ

เมื่อใดควรใช้เครื่องมือนี้แทนการเขียนโค้ด

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