מחולל JSON Schema

הפקת הגדרות JSON Schema תקניות באופן אוטומטי מתוך נתוני JSON לדוגמה.

אודות מחולל JSON Schema — מדריך מפורט

קטגוריה: DevOps ותקנים 100% מקומי בדפדפן

מחולל ה-JSON Schema מסיק מפרטי 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), מספרי נקודה צפה (floats) ופרימיטיבים אחרים
  • זיהוי היוריסטי של פורמטים סמנטיים כולל תאריך-שעה בפורמט ISO (date-time), email ו-uri
  • תיבות סימון חזותיות להפעלת או ביטול אילוצי `required` על מאפיינים עם העתקה מיידית

כיצד להשתמש

  1. 1

    הדבק את מטען ה-JSON המייצג לדוגמה בחלונית הקלט השמאלית.

  2. 2

    לחץ על צור (Generate) כדי לנתח אוטומטית את טיפוסי המאפיינים ואת עומק המבנה.

  3. 3

    שנה את סימון שדות ה-`required` לפי הצורך, ולאחר מכן העתק את ה-JSON Schema שנוצר.

שימושים נפוצים

  • ← יצירת סכמות חוזה מדגימות תגובה של API קיים במהלך בדיקות אינטגרציה
  • ← הכנת סכמות מקור עבור כלים כגון `json-schema-to-typescript`
  • ← אכיפת אילוצים מבניים על מטעני אירועים באפיק הודעות אסינכרוני (message bus)

כלים קשורים

שאלות נפוצות ופרטיות

כיצד הכלי מתמודד עם מערך המכיל אובייקטים בעלי מאפיינים הטרוגניים?

המנוע ממזג את המאפיינים של כל האובייקטים בתוך המערך כדי לבנות סכמת אובייקט מאוחדת המאמתת כל פריט לדוגמה.

כיצד אוכל לאמת נתונים (payloads) מול הסכמה שנוצרה?

ניתן להשתמש בספריות כגון `ajv` בסביבות Node.js או בדפדפן: קמפל את הסכמה באמצעות `const validate = ajv.compile(schema)` והרץ `validate(data)`.