Online JSON – JSON séma generátor

Hogyan működik a séma generálás a háttérben

A JSON séma generálása JSON mintából több lépést igényel, mint pusztán a mezők típushoz rendelése. Ez az eszköz a pontosság és teljesség érdekében a következő kulcsfontosságú lépéseket alkalmazza:

1. Elemzés: Az eszköz az ECMA-404 szabványnak megfelelően elemzi az Ön JSON-ját, és részletes hibajelzést ad hibás vagy kétértelmű szerkezet esetén.
2. Strukturális elemzés: Felépíti az adatai fastruktúráját, osztályozva minden tulajdonságot és elemet a JSON Schema alapvető típusai szerint (objektum, tömb, string, szám, egész, logikai, null).
3. Rekurzív bejárás: Mély és beágyazott szerkezeteket — például objektumtömböket vagy beágyazott tömböket — rekurzívan járja be, hogy beágyazott sémadefiníciókat generáljon.
4. Típusinferálás és egyesítés: Minden tulajdonság vagy tömbelem esetén meghatározza a típust. Ha vegyes típusok fordulnak elő, a 'type' mező tömbként (uniótípus) jelenik meg a JSON Schema specifikáció szerint.
5. Kötelező és opcionális kulcsok felismerése: Az összes objektum elemzésével az eszköz megkülönbözteti az mindig jelenlévő (kötelező) és néha hiányzó (opcionális) kulcsokat.
6. Értékmegszorítások: Lehetőség szerint inferálja az értékkészleteket (enum), számok min/max értékeit, stringek minimális és maximális hosszát, valamint formátumtippeket (pl. 'email', 'uri' vagy 'date-time').
7. Speciális esetek kezelése: Különös figyelmet fordít az üres tömbökre, nullokra és hézagos szerkezetekre, hogy érvényes sémákat hozzon létre, amelyek a valós világ változatosságát tükrözik.
8. Sémaszintézis: A végső séma egy szabványos Draft-07 dokumentumként kerül kiadásra — használatra kész például Ajv, OpenAPI vagy kódgeneráló könyvtárak számára.

Miért érdemes JSON sémát generálni? Gyakorlati felhasználások

• Automatikus validáció: Használja a generált sémákat adatszerződések érvényesítésére és bejövő API, mikroszolgáltatás vagy CLI payloadok validálására.
• API dokumentáció: Automatikusan generáljon dokumentációt és interaktív felfedezőket (Swagger, Postman) pontos adatmódosításokkal.
• Kódgenerálás: Hozzon létre típusbiztos modelleket vagy validátorokat TypeScript, Python, Java és más nyelvekhez, a séma egyetlen igazságforrásként.
• Tesztadat-generálás: Olyan eszközök, mint a JSON Schema Faker vagy a Mockaroo az sémák alapján szintetizálnak valósághű tesztadatokat QA és terheléses teszteléshez.
• Refaktorálás és migráció: Validálja régi vagy változó adatstruktúrákat, biztosítva a kompatibilitást a backend fejlesztései közben.

Műszaki jellemzők

• Draft-07 kompatibilitás a legnagyobb validátorokkal és API tervező platformokkal való maximális együttműködés érdekében.
• Bármilyen mélységű rekurzív elemzés — tömbök tömbben, objektumok tömbben és még több.
• Pontoss teremt az unió típusok ('type' tömb) inferálásában, ha mezők vagy elemek minták szerint változnak.
• Automatikus felismerés enumokra, hosszra, mintázatra, formátumra, min/max értékekre és más gyakori megszorításokra.
• Explicit támogatás null értékekhez, üres tömbökhöz/objektumokhoz és részleges rekordokhoz.
• A séma generálás teljesen a böngészőben történik. Bemeneti JSON-ja soha nem hagyja el az eszközét.

Műszaki példa: Minta JSON-ból Draft-07 séma

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

Hogyan használja ezt az JSON–JSON séma eszközt

1. Illessze be vagy írja be az példamintát az alábbi szerkesztőbe. Az eszköz bármilyen érvényes JSON-t elfogad, az egyszerű objektumoktól a mélyen beágyazott struktúrákig.
2. Kattintson a 'JSON séma generálása' gombra a generált séma megtekintéséhez.
3. Másolja, szerkessze vagy töltse le a sémát. Integrálja közvetlenül API definíciókba, validációs logikába vagy dokumentációba.

JSON séma generáláshoz kódpéldák

Nézze meg, hogyan generálhat JSON Sémát JSON-ból különböző programozási nyelveken.

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.