Онлайн Генератор JSON в JSON Schema

Как работает генерация схемы

Генерация JSON Schema из примера JSON — это не просто сопоставление полей и типов. Этот инструмент выполняет ряд важных шагов для точности и полноты:

1. Парсинг: Инструмент разбирает ваш JSON согласно ECMA-404, сообщая подробные ошибки в случае неправильного или неоднозначного ввода.
2. Структурный анализ: Создаётся древовидное представление данных, классифицируя каждое свойство и элемент по основным типам JSON Schema (объект, массив, строка, число, целое число, булево, null).
3. Рекурсивный обход: Глубокие и вложенные структуры — включая массивы объектов и вложенные массивы — обходятся рекурсивно для генерации вложенных определений схем.
4. Определение и объединение типов: Для каждого свойства или элемента массива выводятся типы. В случаях смешанных типов 'type' выражается как массив (объединённый тип) согласно спецификации JSON Schema.
5. Определение обязательных и необязательных полей: Анализируя все объекты на каждом уровне, инструмент разделяет всегда присутствующие (обязательные) и иногда отсутствующие (необязательные) ключи.
6. Ограничения значений: По возможности выявляются enum (набор допустимых значений), min/max для чисел, minLength/maxLength для строк и подсказки форматов (например, 'email', 'uri', 'date-time').
7. Обработка крайних случаев: Особое внимание уделяется пустым массивам, null и разреженным структурам — обеспечивая валидные схемы с учётом реальной изменчивости данных.
8. Генерация схемы: Финальная схема создаётся в соответствии со спецификацией Draft-07 — готовая к использованию с такими инструментами, как Ajv, OpenAPI или библиотеки генерации кода.

Зачем создавать JSON Schema? Практические применения

• Автоматическая валидация: Используйте сгенерированные схемы для контроля договоров данных и проверки входящих запросов в API, микросервисах или CLI.
• Документация API: Автоматически создавайте документацию и интерактивные браузеры (Swagger, Postman) с точным описанием данных.
• Генерация кода: Создавайте типобезопасные модели или валидаторы для TypeScript, Python, Java и других языков, используя схему как единственный источник правды.
• Генерация тестовых данных: Инструменты вроде JSON Schema Faker или Mockaroo используют схемы для синтеза реалистичных тестовых данных для QA и нагрузочного тестирования.
• Рефакторинг и миграция: Валидируйте устаревшие или изменяющиеся структуры данных, обеспечивая совместимость с развитием вашего бэкенда.

Технические особенности

• Совместимость с Draft-07 для максимальной совместимости с основными валидаторами и платформами проектирования API.
• Рекурсивный анализ любой глубины вложенности — массивы внутри массивов, объекты внутри массивов и др.
• Точное определение объединённых типов ('type' как массив) для полей или элементов с вариациями.
• Автоматическое обнаружение enum, длины, шаблонов, форматов, min/max и других распространённых ограничений.
• Явная поддержка null, пустых массивов/объектов и частичных записей.
• Генерация схемы полностью в браузере. Ваши исходные данные не покидают устройство.

Технический пример: от примера JSON до схемы Draft-07

{
  "transaction": {
    "id": "txn_abc123",
    "amount": 99.95,
    "currency": "USD",
    "status": "completed",
    "meta": {
      "ip": "203.0.113.1",
      "tags": ["recurring", null]
    }
  },
  "refunded": false,
  "notes": null
}

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "transaction": {
      "type": "object",
      "properties": {
        "id": { "type": "string" },
        "amount": { "type": "number" },
        "currency": { "type": "string", "minLength": 3, "maxLength": 3 },
        "status": { "type": "string", "enum": ["completed"] },
        "meta": {
          "type": "object",
          "properties": {
            "ip": { "type": "string", "format": "ipv4" },
            "tags": {
              "type": "array",
              "items": { "type": ["string", "null"] }
            }
          },
          "required": ["ip", "tags"]
        }
      },
      "required": ["id", "amount", "currency", "status", "meta"]
    },
    "refunded": { "type": "boolean" },
    "notes": { "type": ["null"] }
  },
  "required": ["transaction", "refunded", "notes"]
}

Как использовать этот инструмент JSON в JSON Schema

1. Вставьте или введите пример JSON в редактор ниже. Инструмент принимает любой валидный JSON — от простых объектов до сложных вложенных структур.
2. Нажмите «Сгенерировать JSON Schema», чтобы создать и просмотреть полученную схему.
3. Скопируйте, отредактируйте или скачайте схему. Интегрируйте её в определения API, логику валидации или документацию.

Примеры кода для генерации схем из JSON

Узнайте, как создавать JSON Schema из JSON на различных языках программирования.

const generateSchema = require('jsonschema-generator');
const data = {
  name: "Alice",
  age: 30,
  isActive: true,
  tags: ["user", "admin"]
};
const schema = generateSchema(data);
console.log(JSON.stringify(schema, null, 2));

const GenerateSchema = require('generate-schema');
const data = { name: "Alice", age: 30, tags: ["admin", "user"] };
const schema = GenerateSchema.json('User', data);
console.log(JSON.stringify(schema, null, 2));

from genson import SchemaBuilder
sample = {"name": "Alice", "age": 30, "tags": ["user", "admin"]}
builder = SchemaBuilder()
builder.add_object(sample)
print(builder.to_json(indent=2))

from jsonschema_generate import generate_schema
sample = {"name": "Alice", "age": 30, "tags": ["user", "admin"]}
schema = generate_schema(sample)
print(schema)

package main
import (
  "encoding/json"
  "fmt"
  "github.com/invopop/jsonschema"
)
type User struct {
  Name string   `json:"name"
  Age  int      `json:"age"
  Tags []string `json:"tags"
}
func main() {
  schema := jsonschema.Reflect(&User{})
  out, _ := json.MarshalIndent(schema, "", "  ")
  fmt.Println(string(out))
}

# Generate Java POJOs *from* a JSON Schema, not the reverse.
# For schema generation from Java, see tools like jackson-module-jsonSchema.
# See: https://github.com/FasterXML/jackson-module-jsonSchema

using NJsonSchema;
using Newtonsoft.Json.Linq;
var sample = JObject.Parse("{\"name\":\"Alice\",\"age\":30, \"tags\":[\"user\"]}");
var schema = await JsonSchema.FromSampleJsonAsync(sample.ToString());
Console.WriteLine(schema.ToJson());

require 'vendor/autoload.php';
use Swaggest\JsonSchema\Structure\ClassStructure;
$sample = ["name" => "Alice", "age" => 30, "tags" => ["user"]];
$schema = ClassStructure::exportSchema($sample);
echo json_encode($schema, JSON_PRETTY_PRINT);

require 'json_schemer'
sample = { "name" => "Alice", "age" => 30, "tags" => ["admin", "user"] }
schema = JSONSchemer.schema(sample)
puts schema.to_json

echo '{"name":"Alice","age":30,"tags":["user","admin"]}' | genson | jq .

use schemars::JsonSchema;
use serde::Serialize;
#[derive(Serialize, JsonSchema)]
struct User {
  name: String,
  age: u32,
  tags: Vec<String>,
}
fn main() {
  let schema = schemars::schema_for!(User);
  println!("{}", serde_json::to_string_pretty(&schema).unwrap());
}

import json.schema._
case class User(name: String, age: Int, tags: List[String])
val schema = Json.schema[User]
println(schema.asSpray.prettyPrint)

# Generate schema from a TypeScript interface:
typescript-json-schema tsconfig.json User --out schema.json
# See https://github.com/YousefED/typescript-json-schema

// Dart does not have an automatic JSON Schema generator yet.
// Manually define schema as a Dart Map or use online tools.