JSON स्कीमा स्वयं एक JSON दस्तावेज़ है जो उन नियमों को बताता है जिनका पालन किसी अन्य दस्तावेज़ को करना होता है: उसका प्रकार, उसमें मौजूद गुण, आवश्यक गुण, उनके मानों के प्रकार और प्रारूप, स्ट्रिंग और ऐरे की लंबाई। प्रत्येक प्रमुख भाषा में मौजूद वैलिडेटर एक दस्तावेज़ की स्कीमा के आधार पर जाँच करते हैं और प्रत्येक उल्लंघन की रिपोर्ट करते हैं।
टाइप, प्रॉपर्टीज़, रिक्वायर्ड, आइटम्स, एनम, फॉर्मेट और पैटर्न जैसे कीवर्ड मिलकर एक शेप का वर्णन करते हैं; $ref परिभाषाओं का पुन: उपयोग करता है। OpenAPI 3.1 अपने अनुरोध और प्रतिक्रिया निकायों के लिए JSON स्कीमा (ड्राफ्ट 2020-12) का उपयोग करता है, इसलिए API विवरण स्वयं के ट्रैफ़िक के लिए वैलिडेटर्स का एक सेट भी है।
additionalProperties डिफ़ॉल्ट रूप से false होता है। डिफ़ॉल्ट रूप से, स्कीमा उन प्रॉपर्टीज़ की अनुमति देता है जिनका उल्लेख नहीं किया गया है, जिसका अर्थ है कि अप्रत्याशित फ़ील्ड से भरा हुआ रिस्पॉन्स भी मान्य हो जाता है। सख्त कॉन्ट्रैक्ट जांच के लिए additionalProperties: false होना आवश्यक है — या यह स्वीकार करना होगा कि अतिरिक्त फ़ील्ड पकड़े नहीं जा रहे हैं।
प्रत्येक API के ओपन API दस्तावेज़ में उसके बॉडी के लिए JSON स्कीमा एम्बेडेड होते हैं; Try it out से प्राप्त प्रतिक्रिया को संबंधित साइट के JSON से JSON स्कीमा जनरेटर में पेस्ट करें ताकि डेटा से ही अनुमानित स्कीमा प्राप्त हो सके।
सभी शब्द · परीक्षण तकनीकें · सभी 39 मॉक REST API
आखरी अपडेट