JSON Schema जनरेटर (Draft 2020-12)

Q: क्या format सत्यापन लागू होता है?

JSON Schema में `format` डिफ़ॉल्ट रूप से एक एनोटेशन है; ajv जैसे वैलिडेटर में format सत्यापन चालू करना पड़ता है (ajv-formats)।

नमूना JSON से JSON Schema (draft 2020-12) बनाएँ: टाइप, आवश्यक कुंजियाँ, nullable यूनियन, ऐरे आइटम और email व date-time जैसे स्ट्रिंग फ़ॉर्मेट। मुफ़्त।

JSON इनपुट

फ़ाइल खोलें

स्कीमा शीर्षक (वैकल्पिक)

कुंजियों को आवश्यक (required) चिह्नित करेंस्ट्रिंग फ़ॉर्मेट पहचानें (email, date-time, uri…)अतिरिक्त प्रॉपर्टी की अनुमति न दें

JSON Schema आउटपुट

पूरी तरह आपके ब्राउज़र में चलता है। आपका डेटा कभी अपलोड नहीं होता।

JSON Schema जनरेटर क्या है?

किसी उदाहरण दस्तावेज़ से JSON Schema का अनुमान लगाएँ। जनरेटर हर प्रॉपर्टी का टाइप बताता है, ऐरे आइटम को एक items स्कीमा में मिलाता है, आवश्यक कुंजियाँ सूचीबद्ध करता है, nullable मानों को टाइप यूनियन से चिह्नित करता है और आम स्ट्रिंग फ़ॉर्मेट पहचान सकता है।

JSON Schema जनरेटर का उपयोग कैसे करें

JSON इनपुट बॉक्स में JSON पेस्ट करें, या उदाहरण लोड करें या फ़ाइल खोलें इस्तेमाल करें।
चाहें तो स्कीमा शीर्षक (वैकल्पिक) तय करें।
कुंजियों को आवश्यक (required) चिह्नित करें, स्ट्रिंग फ़ॉर्मेट पहचानें (email, date-time, uri…) और अतिरिक्त प्रॉपर्टी की अनुमति न दें चालू या बंद करें।
JSON Schema आउटपुट टाइप करते ही अपडेट होता है; कॉपी करें या डाउनलोड करें इस्तेमाल करें।

उदाहरण

इनपुट

{"id":1,"email":"a@b.co"}

आउटपुट

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer"
    },
    "email": {
      "type": "string",
      "format": "email"
    }
  },
  "required": [
    "id",
    "email"
  ]
}

JSON Schema जनरेटर का उपयोग कब करें

API अनुबंधों, कॉन्फ़िग सत्यापन या फ़ॉर्म जनरेशन के लिए शुरुआती बिंदु के रूप में इसका उपयोग करें। एक नमूने से अनुमानित स्कीमा उतनी ही अच्छी होती है जितना नमूना: असली डेटा सत्यापित करने के लिए इस्तेमाल करने से पहले minimum, enum या pattern जैसी पाबंदियाँ हाथ से जोड़ें।

JSON Schema जनरेटर कैसे काम करता है

नमूने को रिकर्सिव ढंग से पढ़ा जाता है और हर स्थान उन JSON टाइप को इकट्ठा करता है जो उसने देखे (integer, number, string, boolean, object, array, null)। दशमलव के साथ मिले पूर्णांक number बनते हैं; कई टाइप ["object", "null"] जैसा type ऐरे बनते हैं। ऑब्जेक्ट के ऐरे में कोई प्रॉपर्टी तभी required होती है जब हर ऑब्जेक्ट में हो। फ़ॉर्मेट पहचान स्ट्रिंग को date-time, date, time, email, uuid, uri और ipv4 के पैटर्न से जाँचती है और format तभी जोड़ती है जब हर मान मेल खाए। नतीजा $schema: https://json-schema.org/draft/2020-12/schema घोषित करता है।

सामान्य उपयोग मामले

API रिक्वेस्ट बॉडी के लिए स्कीमा शुरू करना
ajv या CI चेक से कॉन्फ़िगरेशन फ़ाइलें सत्यापित करना
वेबहुक पेलोड के आकार का दस्तावेज़ बनाना
JSON Schema स्वीकार करने वाले टूल में स्कीमा से फ़ॉर्म बनाना

अक्सर पूछे जाने वाले प्रश्न

कौन-सा draft बनता है?

Draft 2020-12, जो $schema कीवर्ड से घोषित होता है। इस्तेमाल किए कीवर्ड (type, properties, required, items, format, additionalProperties) draft-07 में भी मान्य हैं।

वैकल्पिक प्रॉपर्टी कैसे पहचानी जाती हैं?

सिर्फ़ ऑब्जेक्ट के ऐरे से: अगर कोई कुंजी कुछ एलिमेंट में नहीं है, तो वह required से बाहर रहती है। एक ऑब्जेक्ट के लिए विकल्प चालू होने पर हर कुंजी required होती है।