Online JSON till JSON Schema Generator

Hur schemagenerering fungerar under huven

Att generera JSON Schema från ett JSON-exempel innebär mer än att mappa fält till typer. Detta verktyg använder flera viktiga steg för korrekthet och fullständighet:

1. Parsing: Verktyget analyserar din JSON enligt ECMA-404 och rapporterar detaljerade fel vid felaktig indata eller tvetydiga konstruktioner.
2. Strukturanalys: Det bygger en trädstruktur av dina data och klassificerar varje egenskap och element enligt JSON Schemas kärntyper (objekt, array, sträng, nummer, heltal, boolean, null).
3. Rekursiv genomsökning: Djupa och nästlade strukturer—inklusive arrayer med objekt eller nästlade arrayer—genomsöks rekursivt för att generera nästlade schema-definitioner.
4. Typinferens och sammanslagning: Typer infereras för varje egenskap eller arrayelement. När egenskaper eller element har blandade typer uttrycks 'type' som en array (unionstyp) enligt JSON Schema-specifikation.
5. Identifiering av obligatoriska vs. frivilliga: Genom att analysera alla objekt på varje nivå skiljer verktyget mellan alltid närvarande (obligatoriska) och ibland saknade (frivilliga) nycklar.
6. Värdebegränsningar: När det är möjligt infererar verktyget enums (tillåtna värden), min/max för tal, minLength/maxLength för strängar och formathinvis (såsom 'email', 'uri' eller 'date-time').
7. Hantering av specialfall: Särskild uppmärksamhet ges till tomma arrayer, null-värden och glest strukturerade data—för att säkerställa giltiga scheman som matchar verklig variation.
8. Schema-syntes: Det slutgiltiga schemat skickas ut som ett standardkompatibelt Draft-07-dokument—klart för användning med verktyg som Ajv, OpenAPI eller kodgenereringsbibliotek.

Varför generera JSON Schema? Praktiska användningsområden

• Automatisk validering: Använd genererade scheman för att säkerställa datakontrakt och validera inkommande data i dina API:er, mikrotjänster eller kommandoradsverktyg.
• API-dokumentation: Automatiskt generera dokumentation och interaktiva explorationsverktyg (Swagger, Postman) med exakta datadefinitioner.
• Kodgenerering: Skapa typ-säkra modeller eller validatorer i TypeScript, Python, Java och andra språk med ditt schema som enda sanningskälla.
• Testdatagenerering: Verktyg som JSON Schema Faker eller Mockaroo använder scheman för att skapa realistiska mockdata för QA och belastningstestning.
• Refaktorering & migration: Validera äldre eller förändrade datastrukturer för att säkerställa kompatibilitet när din backend utvecklas.

Tekniska funktioner

• Draft-07-kompatibilitet för maximal interoperabilitet med viktiga validatorer och API-designplattformar.
• Rekursiv analys på valfri nästlingsnivå—arrayer i arrayer, objekt i arrayer, med mera.
• Exakt inferens av unionstyper ('type' som array) för fält eller element med varierande typer i exempel.
• Automatisk detektion av enums, längd, mönster, format, min/max och andra vanliga begränsningar.
• Explicit stöd för nullvärden, tomma arrayer/objekt och partiella poster.
• Schemagenerering sker helt i webbläsaren. Din inmatade JSON lämnar aldrig din enhet.

Tekniskt exempel: Från JSON-exempel till Draft-07-schema

{
  "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"]
}

Hur man använder detta JSON till JSON Schema-verktyg

1. Klistra in eller skriv ditt exempel-JSON i redigeraren nedan. Verktyget accepterar all giltig JSON, från enkla objekt till djupt nästlade strukturer.
2. Klicka på 'Generera JSON-schema' för att skapa och visa det genererade JSON-schemat.
3. Kopiera, redigera eller ladda ner schemat. Integrera det direkt i dina API-definitioner, valideringslogik eller dokumentation.

Kodexempel för generering av schema från JSON

Se hur du genererar JSON Schema från JSON i olika programmeringsspråk.

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.