JSON Schema is a vocabulary for describing the structure of JSON data. It defines expected types, required properties, formats, and constraints, enabling automatic validation of JSON documents.

Which JSON Schema drafts are supported?

This validator supports JSON Schema drafts 04, 06, 07, and 2019-09 via the AJV library.

What is the difference between JSON Schema validation and JSON formatting?

JSON formatting checks syntax (is the JSON valid JSON?). JSON Schema validation checks structure — does this JSON conform to a specific schema defining its expected shape and required fields?

Can I use this to validate API request and response bodies?

Yes. Paste your API payload as the JSON document and your OpenAPI or JSON Schema definition as the schema to instantly check compliance without running your server.

اعتبارسنج طرح‌وارهٔ JSON

نمونه‌ها

نتیجه اعتبارسنجی

JSON با شِما معتبر است

طرح‌وارهٔ JSON

داده‌های JSON

Loading editor...

جزئیات فنی

اعتبارسنج JSON Schema چگونه کار می‌کند

این ابزار چه کاری انجام می‌دهد

این اعتبارسنج JSON Schema داده‌های JSON را در برابر یک JSON Schema (draft-04، draft-06، draft-07 یا 2019-09) بررسی می‌کند. گزارش می‌دهد که آیا داده معتبر است یا نه، و اگر نامعتبر باشد مسیر، کلیدواژه و پیام هر خطا را نشان می‌دهد تا بتوانید داده را اصلاح کنید یا اسکیما را تنظیم کنید.

موارد استفادهٔ رایج برای توسعه‌دهندگان

توسعه‌دهندگان از اعتبارسنج JSON Schema برای تست payloadهای درخواست/پاسخ API، اعتبارسنجی فایل‌های پیکربندی، تولید یا دیباگ اعتبارسنجی مبتنی بر اسکیما در کد، و اطمینان از صحت OpenAPI یا سایر قالب‌های مبتنی بر اسکیما استفاده می‌کنند. همچنین هنگام ساخت فرم‌ها یا پایپ‌لاین‌های ETL که به JSON Schema متکی هستند مفید است.

ورودی اسکیما و داده

JSON Schema خود را در یک پنل بچسبانید یا بارگذاری کنید و داده JSON خود را در پنل دیگر قرار دهید. ابزار هر دو را تجزیه می‌کند و اعتبارسنجی را اجرا می‌کند. نسخه‌های پشتیبانی‌شده اسکیما از روی کلیدواژه "$schema" تشخیص داده می‌شوند. JSON نامعتبر در هر یک از پنل‌ها قبل از اجرای اعتبارسنجی گزارش می‌شود.

دام‌های رایج و حالت‌های لبه‌ای

مطمئن شوید خود اسکیما یک JSON معتبر است و از یک URL پشتیبانی‌شده برای "$schema" استفاده می‌کند. داده خالی یا داده‌ای که شیء نیست می‌تواند بسته به اسکیما معتبر یا نامعتبر باشد (مثلاً فیلدهای required، محدودیت‌های type). خطاهای تو در تو با نمادگذاری مسیر نمایش داده می‌شوند؛ یک خطا را رفع کنید و دوباره اجرا کنید تا مشکلات باقی‌مانده را ببینید.

چه زمانی از این ابزار استفاده کنیم در برابر کُد

از این اعتبارسنج برای بررسی‌های سریع، دیباگ و بررسی اسکیماها استفاده کنید. برای محیط تولید، اعتبارسنجی را در اپ خود با کتابخانه‌ای مثل Ajv یا مشابه آن اجرا کنید و اسکیما و منطق اعتبارسنجی را در کنترل نسخه و تست‌ها نگه دارید.