Generador en línia de JSON a JSON Schema

Com funciona la generació de l'esquema internament

Generar JSON Schema a partir d'una mostra JSON implica més que mapar camps a tipus. Aquesta eina segueix diversos passos clau per a la correcció i exhaustivitat:

1. Anàlisi sintàctica: L'eina analitza el teu JSON segons ECMA-404, informant d'errors detallats per entrada mal formada o constructes amb ambigüitat.
2. Anàlisi estructural: Construeix una representació en arbre de les teves dades, classificació de propietats i elements segons els tipus bàsics de JSON Schema (objecte, array, cadena, número, enter, booleà, null).
3. Recorregut recursiu: S'analitzen recursivament les estructures profundes i aniuades—incloent arrays d'objectes o arrays aniuats—per generar definicions d'esquema també aniuades.
4. Inferència i fusió de tipus: Per a cada propietat o element d'array s'inferen els tipus. Quan hi ha tipus mixtos, el camp 'type' s'expressa com una matriu (tipus unió) segons l'especificació JSON Schema.
5. Detecció de requerits vs. opcionals: Analitzant tots els objectes a cada nivell, l'eina distingeix entre claus sempre presents (requerides) i ocasionalment absents (opcions).
6. Restriccions de valor: Quan és possible, s'inferen enums (valors permesos), min/màxim per números, minLength/maxLength per cadenes, i suggeriments de format (com 'email', 'uri' o 'date-time').
7. Gestió de casos límit: S'hi presta especial atenció a arrays buits, valors null i estructures disperses—garantint esquemes vàlids que s'ajusten a la variabilitat real.
8. Síntesi de l'esquema: L'esquema final s'emet com un document estandarditzat Draft-07—preparat per a eines com Ajv, OpenAPI o biblioteques de generació de codi.

Per què generar JSON Schema? Usos pràctics

• Validació automatitzada: Utilitza esquemes generats per fer complir contractes de dades i validar les càrregues entrants en les teves APIs, microserveis o línies d'ordres.
• Documentació d'API: Autogenera documentació i exploradors interactius (Swagger, Postman) amb definicions de dades precises.
• Generació de codi: Crea models o validadors amb tipatge fort en TypeScript, Python, Java i altres llenguatges usant l'esquema com a font única de veritat.
• Generació de dades de prova: Eines com JSON Schema Faker o Mockaroo utilitzen esquemes per sintetitzar dades simulades realistes per a proves QA i de càrrega.
• Refactorització i migració: Valida estructures de dades antigues o que evolucionen, assegurant compatibilitat a mesura que el teu backend canvia.

Característiques tècniques

• Compatibilitat amb Draft-07 per a màxima interoperabilitat amb validadors i plataformes de disseny d'API principals.
• Anàlisi recursiva de qualsevol profunditat d'anidament—arrays dins arrays, objectes dins arrays, i més.
• Inferència precisa de tipus unió (matriu 'type') per a camps o elements que varien entre mostres.
• Detecció automàtica d'enums, longitud, patrons, formats, min/màxim i altres restriccions comunes.
• Suport explícit per a nulls, arrays/objects buits i registres parcials.
• La generació de l'esquema es fa completament al navegador. El teu JSON d'entrada mai surt del teu dispositiu.

Exemple tècnic: De JSON mostra a esquema 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"]
}

Com utilitzar aquesta eina de JSON a JSON Schema

1. Enganxa o escriu el teu JSON d'exemple a l'editor a continuació. L'eina accepta qualsevol JSON vàlid, des d'objectes simples fins a estructures profundament aniuades.
2. Prem 'Genera l'Esquema JSON' per generar i veure l'esquema JSON produït.
3. Copia, edita o descarrega l'esquema. Integra'l directament a les definicions de la teva API, a la lògica de validació o a la documentació.

Exemples de Codi per a la Generació d'Esquemes des de JSON

Descobreix com generar un esquema JSON a partir de JSON en diversos llenguatges de programació.

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.