JSON Schema परिचय: JSON संरचना को नियमों के साथ सत्यापित करें

2024-04-13

सिर्फ valid syntax होना पर्याप्त नहीं है। फ़ील्ड गलत हो सकती हैं, type mismatch हो सकता है। JSON Schema इन्हीं त्रुटियों को पकड़ता है।

Minimal schema

Root type object या array तय करें, फिर properties और required सूची लिखें।

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

Common keywords

type, enum, items, additionalProperties: false, oneOf और $ref सबसे अधिक उपयोगी हैं।

कोड में उपयोग

JavaScript में ajv, Python में jsonschema और Go में gojsonschema आम विकल्प हैं।

OpenAPI में body definitions अक्सर JSON Schema अवधारणा पर आधारित होती हैं।

Syntax check से अंतर

JSON.parse syntax बताता है; Schema business structure बताता है। दोनों को क्रम से चलाना चाहिए।

टीम में अपनाना

Schema को रिपॉजिटरी में रखें और CI में fixtures validate करें ताकि API बदलाव नियंत्रित रहें।