Online JSON til JSON Schema-generator

Slik fungerer skjema-generering under panseret

Å generere JSON Schema fra eksempel-JSON innebærer mer enn å bare knytte felter til typer. Dette verktøyet benytter flere viktige steg for korrekthet og fullstendighet:

1. Parsing: Verktøyet parser JSON-en din i henhold til ECMA-404 og rapporterer detaljerte feil for feil-formatert input eller tvetydige konstruksjoner.
2. Strukturell analyse: Det bygger en trestruktur av dataene dine, klassifiserer hver egenskap og element i henhold til JSON Schemas hovedtyper (objekt, matrise, streng, tall, heltall, boolsk, null).
3. Rekursiv gjennomgang: Dype og nestede strukturer—inkludert matriser av objekter eller nestede matriser—gås gjennom rekursivt for å generere nestede skjema-definisjoner.
4. Typeavledning og sammenslåing: For hver egenskap eller matriseelement avledes typen. Der felter eller elementer har blandede typer, uttrykkes 'type' som en matrise (unionstype) i henhold til JSON Schema-spesifikasjonen.
5. Påkrevd vs. valgfri deteksjon: Ved å analysere alle objekter på hvert nivå skiller verktøyet mellom alltid tilstedeværende (påkrevd) og noen ganger fraværende (valgfri) nøkler.
6. Verdibegrensninger: Når mulig, avledes enums (sett med tillatte verdier), min/maks for tall, minLengde/maksLengde for strenger, og format-tips (som 'email', 'uri', eller 'date-time').
7. Håndtering av spesialtilfeller: Spesiell oppmerksomhet gis til tomme matriser, nullverdier og sparsomme strukturer—for å sikre gyldige skjemaer som matcher reell variasjon.
8. Skjemasyntese: Det endelige skjemaet utstedes som et standardkompatibelt Draft-07-dokument—klart til bruk med verktøy som Ajv, OpenAPI eller kodegenereringsbiblioteker.

Hvorfor generere JSON Schema? Praktiske bruksområder

• Automatisert validering: Bruk genererte skjemaer for å håndheve datakontrakter og validere innkommende data i API-er, mikrotjenester eller CLI-verktøy.
• API-dokumentasjon: Autogenerer dokumentasjon og interaktive utforskere (Swagger, Postman) med presise datadefinisjoner.
• Kodegenerering: Lag typesikre modeller eller validatorer i TypeScript, Python, Java og andre språk ved å bruke skjemaet som eneste kilde til sannhet.
• Testdatagenerering: Verktøy som JSON Schema Faker eller Mockaroo bruker skjemaer for å syntetisere realistiske falske data til QA og belastningstesting.
• Refaktorisering & migrasjon: Valider eldre eller endrede datastrukturer og sørg for kompatibilitet etterhvert som backend utvikler seg.

Tekniske funksjoner

• Draft-07-kompatibilitet for maksimal interoperabilitet med store validatorer og API-designplattformer.
• Rekursiv analyse av vilkårlig dybde – matriser i matriser, objekter i matriser, og mer.
• Nøyaktig unionstype ('type'-matrise) avledning for felt eller elementer som varierer mellom prøver.
• Automatisk deteksjon av enums, lengde, mønster, format, min/maks og andre vanlige begrensninger.
• Eksplisitt støtte for nuller, tomme matriser/objekter og delvise oppføringer.
• Skjema-generering skjer helt i nettleseren. Din input JSON forlater aldri enheten din.

Teknisk eksempel: Fra eksempel-JSON til Draft-07-skjema

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

Slik bruker du dette JSON til JSON Schema-verktøyet

1. Lim inn eller skriv inn eksempel-JSON-en din i editoren nedenfor. Verktøyet godtar all gyldig JSON, fra enkle objekter til dypt nestede strukturer.
2. Klikk på 'Generer JSON Schema' for å produsere og vise det genererte JSON-skjemaet.
3. Kopier, rediger eller last ned skjemaet. Integrer det direkte i API-definisjonene, valideringslogikken eller dokumentasjonen din.

Kodeeksempler for generering av skjema fra JSON

Se hvordan du genererer JSON Schema fra JSON i ulike 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.