Онлайн генератор JSON до JSON Schema

Як працює генерація схеми під капотом

Генерація JSON Schema з прикладу JSON — це більше, ніж просто відповідність полів типам. Цей інструмент використовує кілька важливих кроків для точності та повноти:

1. Парсинг: Інструмент розбирає ваш JSON відповідно до ECMA-404, повідомляючи докладні помилки у випадку некоректного або неоднозначного вводу.
2. Структурний аналіз: Створюється деревоподібне представлення даних, де кожна властивість і елемент класифікуються за основними типами JSON Schema (object, array, string, number, integer, boolean, null).
3. Рекурсивне проходження: Глибокі та вкладені структури — зокрема масиви об'єктів чи вкладені масиви — рекурсивно проходяться для формування вкладених визначень схеми.
4. Виведення та об'єднання типів: Для кожної властивості або елемента масиву визначаються типи. Якщо є змішані типи, 'type' задається у вигляді масиву (union тип) згідно з JSON Schema.
5. Виявлення обов’язкових та необов’язкових: Аналізуються всі об'єкти на рівні, щоб відокремити ключі, що завжди присутні (обов’язкові), від тих, що іноді відсутні (необов’язкові).
6. Обмеження значень: Там, де можливо, визначаються enum (дозволені значення), мінімум/максимум для чисел, мінімальна/максимальна довжина для рядків, підказки формату (наприклад «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 використовують схеми для синтезу реалістичних мок-даних для тестування і навантаження.
• Рефакторинг та міграція: Перевіряйте сумісність змін або спадкових структур даних під час розвитку бекенду.

Технічні особливості

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

Технічний приклад: від 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.