Руководство по схеме JSON
Прежде чем мы перейдем к схеме JSON, важно знать разницу между JSON и схемой JSON.
JSON
JSON — это сокращение от JavaScript Object Notation, и это независимый от языка формат данных, который API используют для отправки запросов и ответов. JSON легко читать и писать как для людей, так и для машин. JSON — это текстовый формат, который не привязан к языку (не зависит от языка).
Схема JSON
Схема JSON — полезный инструмент для проверки структуры данных JSON. Чтобы указать структуру JSON, используйте формат на основе JSON. Его цель — убедиться, что данные JSON приемлемы. Соглашение для данных JSON нашего приложения может быть определено с помощью схемы.
Спецификация схемы JSON состоит из трех основных разделов:
Гиперсхема JSON:
JSON Hyper-Schema — это язык схемы JSON, который можно использовать для маркировки документов JSON гиперссылками и инструкциями по обработке и изменению внешних ресурсов JSON через текстовые среды, такие как HTTP. Нажмите здесь чтобы узнать больше о гиперсхеме JSON.
Ядро схемы JSON:
Это набор правил для маркировки и проверки документов JSON.
Ядро схемы JSON:
- Описывает формат данных, который у вас есть в настоящее время.
- Проверяет данные, которые можно использовать в автоматизированном тестировании.
- Обеспечение достоверности данных, предоставляемых клиентами.
- Предоставляет удобочитаемую документацию как для людей, так и для машин.
Проверка схемы JSON:
Проверка на основе схемы JSON накладывает ограничения на структуру данных экземпляра. После этого любые ключевые слова, не имеющие утверждения информация, такие как описательные метаданные и указания использования, добавляются к позиции экземпляра, которая соответствует всем объявленным ограничениям.
Инструмент Newtonsoft JSON Schema Validator — это инструмент, который вы можете использовать прямо в своем браузере бесплатно. Вы можете использовать этот инструмент для проверки структуры вашей схемы JSON. Эта страница содержит элементы управления и пояснения, которые помогут вам начать работу. Таким образом, легко понять, как улучшить структуру JSON.
Мы можем проверить наш объект JSON с помощью инструмента проверки схемы JSON:
У нас есть проверка возраста (минимум = 20 и максимум = 40), как показано на рисунке выше. Ошибок не обнаружено.
Он отображал ошибку, если проверка возраста была введена неправильно.
Создание схемы JSON
Давайте посмотрим на пример схемы JSON, чтобы понять, о чем мы говорим. Базовый объект JSON, описывающий каталог продуктов, выглядит следующим образом:
Его схема JSON может быть записана следующим образом:
Схема JSON — это документ JSON, и этот документ ДОЛЖЕН быть объектом. Ключевые слова — это члены/атрибуты объекта, указанные схемой JSON. «Ключевые слова» в схеме JSON относятся к «ключевой» части комбинации ключ/значение в объекте. Написание схемы JSON включает в себя сопоставление определенного «ключевого слова» со значением внутри объекта по большей части.
Давайте подробнее рассмотрим ключевые слова, которые мы использовали в нашем примере:
Схема JSON, которой соответствует схема ресурса, записывается этим атрибутом. Эта схема написана в соответствии со стандартом drafts v4, как указано в «$ schemaключевое слово. Это предотвратит откат вашей схемы к текущей версии, которая может быть или не быть совместимой со старой.
"название(Основной ключ) и описаниеключевые слова просто поясняющие; они не накладывают никаких ограничений на проверяемые данные. Эти два ключевых слова описывают цель схемы: она описывает продукт.
"напишитеключевое слово определяет первое граничное условие наших данных JSON; это должен быть объект JSON. Если мы не установим тип для всех схем, код не будет работать. Некоторые распространенные типы: «число», «логическое», «целое», «нуль», «объект», «массив», «строка».
Схема JSON поддерживается следующими библиотеками:
Язык | Библиотека |
C | WJElement |
Питон | джшон |
PHP | Описание для Схема Json |
JavaScript | айв |
Go | схема Гойсона |
Котлин | Медея-валидатор |
Ruby | JSONSchemer |
JSON (синтаксис)
Давайте кратко рассмотрим фундаментальный синтаксис JSON. Синтаксис JSON — это подмножество синтаксиса JavaScript, включающее следующие элементы:
- Пары имя/значение используются для представления данных.
- Объекты заключаются в фигурные скобки, и каждое имя начинается с ':' (двоеточие), а пары значений разделяются "," (запятая).
- Значения разделяются знаком «,» (запятая), а массивы заключаются в квадратные скобки.
Следующие две структуры данных поддерживаются JSON:
- Упорядоченный список значений: Это может быть массив, список или вектор.
- Коллекция пар имя/значение: Различные компьютерные языки поддерживают эту структуру данных.
JSON (объект)
Схема JSON — это объект JSON, который определяет тип и структуру другого объекта JSON. Выражение объекта JavaScript может представлять объект JSON в средах выполнения JavaScript. Ниже приведены некоторые примеры допустимых объектов схемы:
Схема | Матчи |
{} | любое значение |
{ тип: 'объект' } | объект JavaScript |
{ тип: 'число' } | номер JavaScript |
{ тип: 'строка'} | строка JavaScript |
Например:
Создание нового объекта, который пуст:
вар JSON_Obj = {};
Создание нового объекта:
var JSON_Obj = новый объект()
JSON (сравнение с XML)
JSON и XML — это независимые от языка удобочитаемые форматы. В реальных сценариях они могут создавать, читать и декодировать. Основываясь на следующих критериях, мы можем сравнить JSON с XML.
Многогранность
Поскольку XML сложнее, чем JSON, программисты предпочитают JSON.
Использование массивов
XML используется для выражения структурированных данных; однако XML не поддерживает массивы, а JSON поддерживает.
анализ
JSON интерпретируется с помощью функции JavaScript eval. eval возвращает описанный объект при использовании с JSON.
Пример:
JSON | XML |
{ «компания»: Феррари, «имя»: «ГТС», «цена»: 404000 } |
Феррари
ГТС
404000
|
Преимущества схемы JSON
JSON предназначен для отклонения на человеко- и машиночитаемом языке. Однако без некоторой тонкой настройки не может быть ни того, ни другого. Схема JSON имеет то преимущество, что делает JSON более понятным как для машин, так и для людей.
Использование схемы JSON также устраняет необходимость в нескольких обновлениях на стороне клиента. Составление списка общих HTML-кодов и последующая реализация их на стороне клиента — типичный, но неточный метод построения клиентской части. API Программы. Однако это не лучшая стратегия, поскольку изменения на стороне сервера могут привести к сбоям в работе некоторых функций.
Основным преимуществом JSON Schema является ее совместимость с различными языками программирования, а также точность и согласованность проверки.
Схема JSON поддерживает широкий спектр браузеров и операционные системы, поэтому приложения, написанные в JSON, не требуют больших усилий, чтобы сделать их совместимыми с браузером. При разработке разработчики рассматривают несколько браузеров, хотя возможности JSON уже есть.
JSON — это наиболее эффективный способ обмена данными любого размера, включая аудио, видео и другие медиафайлы. Это связано с тем, что JSON хранит данные в массивах, что упрощает передачу данных. В результате JSON является лучшим форматом файлов для онлайн-API и разработки.
Поскольку API становятся все более распространенными, логично предположить, что проверка и тестирование API будут становиться все более важными. Также реалистично ожидать, что JSON вряд ли станет намного проще с течением времени. Это означает, что наличие схемы для ваших данных будет становиться все более важным с течением времени. Поскольку JSON является стандартным форматом файла для работы с API, схема JSON является хорошей заменой для тех, кто работает с API.
