Категории

Генератор JSON Schema

Автоматически выводит JSON Schema из примера JSON, поддерживает ручную правку и проверку

Подходит для API и дата-инженерии. Можно сгенерировать схему, отредактировать ее и снова проверить пример.

Примеры результатов

1 Примеры

Infer schema from API payload

Turn a sample response into a reusable JSON Schema and validate it immediately

{
  "summary": {
    "valid": true
  },
  "inferredSchema": {
    "type": "object"
  }
}
Показать параметры ввода
{ "sampleJson": "{\n \"id\": 101,\n \"email\": \"[email protected]\",\n \"roles\": [\n \"admin\",\n \"user\"\n ],\n \"profile\": {\n \"active\": true\n }\n}", "draft": "2020-12", "inferEnums": true, "detectFormats": true, "validateAdjustedSchema": true }

Ключевые факты

Категория
Development
Типы входных данных
textarea, select, checkbox
Тип результата
json
Покрытие примерами
4
API доступен
Yes

Обзор

Генератор JSON Schema позволяет мгновенно создавать структуру данных на основе предоставленного примера JSON. Инструмент поддерживает автоматическое определение типов, форматов и перечислений, а также предоставляет возможность ручной корректировки схемы и её последующей валидации для обеспечения точности API-контрактов.

Когда использовать

  • При разработке API, когда необходимо быстро описать структуру входящих или исходящих данных.
  • Для автоматизации создания документации на основе реальных ответов сервера.
  • При необходимости проверки соответствия JSON-файлов заданной спецификации перед их использованием в коде.

Как это работает

  • Вставьте ваш пример JSON в поле ввода для автоматического анализа структуры.
  • Выберите версию стандарта (2020-12 или Draft-07) и настройте параметры определения форматов и перечислений.
  • Получите сгенерированную схему, при необходимости отредактируйте её вручную в поле для правок.
  • Используйте функцию валидации, чтобы убедиться, что ваш пример JSON полностью соответствует обновленной схеме.

Сценарии использования

Создание контрактов для REST API на основе тестовых данных.
Генерация документации для интеграций между микросервисами.
Валидация конфигурационных файлов перед их загрузкой в систему.

Примеры

1. Генерация схемы для профиля пользователя

Backend-разработчик
Контекст
Разработчик создает новый эндпоинт для получения данных пользователя и хочет быстро подготовить документацию.
Проблема
Ручное написание JSON Schema для вложенных объектов занимает много времени и чревато ошибками.
Как использовать
Вставить JSON-ответ от сервера в поле 'Пример JSON' и нажать кнопку генерации.
Пример конфигурации
{"draft": "2020-12", "detectFormats": true, "inferEnums": true}
Результат
Получена готовая JSON Schema с корректно определенными типами полей и форматом email, готовая к вставке в Swagger.

2. Валидация сложного конфигурационного файла

Дата-инженер
Контекст
Инженер получил JSON-конфиг от внешней системы и хочет убедиться, что он соответствует ожидаемой структуре.
Проблема
Необходимо проверить, не пропущены ли обязательные поля и верны ли типы данных.
Как использовать
Загрузить пример конфигурации, сгенерировать схему, внести правки для обязательных полей и запустить валидацию.
Пример конфигурации
{"validateAdjustedSchema": true}
Результат
Система подтвердила валидность конфигурации, указав на соответствие всех полей заданной схеме.

Проверить на примерах

json

Связанные хабы

FAQ

Какие версии JSON Schema поддерживаются?

Инструмент поддерживает стандарты 2020-12 и Draft-07.

Можно ли вручную изменить сгенерированную схему?

Да, вы можете отредактировать полученный код в поле 'Исправленный JSON Schema' и сразу проверить его валидность.

Что делает опция 'Определять типовые форматы'?

Она автоматически распознает такие форматы, как email, даты или URI, и добавляет их в описание полей схемы.

Как работает функция 'Выводить enum из массивов'?

Если массив содержит ограниченный набор строковых значений, инструмент предложит использовать их в качестве перечисления (enum) в схеме.

Нужно ли устанавливать дополнительное ПО?

Нет, это веб-инструмент, который работает непосредственно в вашем браузере.

Документация API

Конечная точка запроса

POST /ru/api/tools/json-schema-generator

Параметры запроса

Имя параметра Тип Обязательно Описание
sampleJson textarea Да -
draft select Нет -
inferEnums checkbox Нет -
detectFormats checkbox Нет -
adjustedSchemaJson textarea Нет -
validateAdjustedSchema checkbox Нет -

Формат ответа

{
  "key": {...},
  "metadata": {
    "key": "value"
  },
  "error": "Error message (optional)",
  "message": "Notification message (optional)"
}
Данные JSON: Данные JSON

Документация MCP

Добавьте этот инструмент к конфигурации сервера MCP:

{
  "mcpServers": {
    "elysiatools-json-schema-generator": {
      "name": "json-schema-generator",
      "description": "Автоматически выводит JSON Schema из примера JSON, поддерживает ручную правку и проверку",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=json-schema-generator",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

Вы можете объединять несколько инструментов, например: `https://elysiatools.com/mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp`, максимум 20 инструментов.

Если вы столкнулись с проблемами, пожалуйста, свяжитесь с нами по адресу [email protected]