JSON Schema – آموزش JSON

  • پنج شنبه ۱۱ مهر ۱۳۹۸
  • بازدید ۵۷ نفر

json schema 7154 تصویر

JSON Schema

JSON Schema مشخصاتی برای قالب مبتنی بر JSON برای تعریف ساختار داده های جیسون است. این Schema تحت پیش نویس IETF که در سال ۲۰۱۱ منقضی شد، نوشته شده است.

JSON Schema:

  • قالب داده های موجود خود را توصیف می کند.
  • اسناد تمیز و قابل خواندن برای انسان و دستگاه.
  • اعتبارسنجی کامل ساختاری، مفید برای Automated Testing.
  • اعتبارسنجی کامل ساختاری، اعتبارسنجی داده های ارسالی کلاینت.

کتابخانه های اعتبار سنجی JSON Schema

در حال حاضر چندین validator برای زبان های برنامه نویسی مختلف در دسترس است. کاملترین و سازگارترین آن ها JSV است.

زبان های برنامه نویسیکتاخانه ها
CWJElement (LGPLv3)
Javajson-schema-validator (LGPLv3)
.NETJson.NET (MIT)
ActionScript 3Frigga (MIT)
Haskellaeson-schema (MIT)
PythonJsonschema
Rubyautoparse (ASL 2.0); ruby-jsonschema (MIT)
PHPphp-json-schema (MIT). json-schema (Berkeley)
JavaScriptOrderly (BSD); JSV; json-schema; Matic (MIT); Dojo; Persevere (modified BSD or AFL 2.0); schema.js.

مثال JSON Schema

در زیر یک مثال از JSON schema را مشاهده می کنید که کاتالوگ محصولات کلاسیک را شرح می دهد.

در جدول زیر می توانید مهمترین کلمات کلیدی قابل استفاده در Schema را مشاهده کنید:

ردیفتوضیحات
۱$schema

کلمه کلیدی $schema بیان می کند که این schema با توجه به مشخصات پیش نویس v4 نوشته شده است.

۲title

به منظور مشخص کردن یک عنوان برای schema استفاده می شود.

۳description

توضیحات مختصری در مورد schema.

۴type

اولین محدودیت را بر روی داده های JSON ما تعریف می کند (باید یک JSON Object باشد).

۵properties

کلیدهای مختلف را به همراه نوع مقادیر، کمترین و بیشترین مقداری قابل پذیریش برای استفاده در فایل JSON تعریف می کند.

۶required

لیستی از پراپرتی های لازم را نگه می دارد.

۷minimum

این محدودیتی است که بر روی مقدار اعمال می شود و کمترین مقداری قابل پذیرش را نشان می دهد.

۸maximum

این محدودیتی است که بر روی مقدار اعمال می شود و بیشترین مقداری قابل پذیرش را نشان می دهد.

۹maxLength

طول رشته نمونه به عنوان حداکثر تعداد کاراکترهای آن تعریف شده است.

۱۰minLength

طول رشته نمونه به عنوان حداقل تعداد کاراکترهای آن تعریف شده است.

۱۱pattern

اگه نمونه رشته با عبارت منظم مطابقت داشته باشد، معتر است.

برای مشاهده لیست کامل کلمات کلیدی قابل استفاده در schema می توانید به سایت json-schema.org مراجعه کنید. Schema تعریف شده در بالا می تواند برای بررسی اعتبار کد زیر قابل استفاده است.

ثبت نظر
ریفریش کنید!
نظرات کاربران (۰ مورد)

هیچ نظری ثبت نشده است