Kategorien

JSON-Schema-Generator

Leitet JSON Schema aus Beispiel-JSON ab und unterstuetzt manuelle Anpassung sowie Validierung

Geeignet fuer API-Entwicklung und Daten-Workflows. Schema erzeugen, anpassen und direkt validieren.

Beispielergebnisse

1 Beispiele

Infer schema from API payload

Turn a sample response into a reusable JSON Schema and validate it immediately

{
  "summary": {
    "valid": true
  },
  "inferredSchema": {
    "type": "object"
  }
}
Eingabeparameter anzeigen
{ "sampleJson": "{\n \"id\": 101,\n \"email\": \"[email protected]\",\n \"roles\": [\n \"admin\",\n \"user\"\n ],\n \"profile\": {\n \"active\": true\n }\n}", "draft": "2020-12", "inferEnums": true, "detectFormats": true, "validateAdjustedSchema": true }

Wichtige Fakten

Kategorie
Development
Eingabetypen
textarea, select, checkbox
Ausgabetyp
json
Sample-Abdeckung
4
API verfügbar
Yes

Überblick

Der JSON-Schema-Generator ermöglicht es Entwicklern, aus einem vorhandenen JSON-Beispiel präzise JSON-Schemas abzuleiten, diese manuell anzupassen und direkt gegen das Datenmodell zu validieren.

Wann verwenden

  • Bei der Erstellung von API-Dokumentationen basierend auf vorhandenen Beispiel-Payloads.
  • Zur schnellen Definition von Datenstrukturen für neue Microservices oder Daten-Pipelines.
  • Wenn bestehende JSON-Daten auf Konformität mit einem definierten Schema geprüft werden müssen.

So funktioniert es

  • Fügen Sie Ihr Beispiel-JSON in das Eingabefeld ein.
  • Wählen Sie die gewünschte Schema-Version (z. B. 2020-12) und aktivieren Sie Optionen wie die Formaterkennung.
  • Das Tool generiert automatisch ein valides JSON-Schema, das Sie bei Bedarf manuell verfeinern können.
  • Nutzen Sie die integrierte Validierungsfunktion, um sicherzustellen, dass Ihr angepasstes Schema korrekt mit dem Beispiel harmoniert.

Anwendungsfälle

Automatisierte Erstellung von API-Verträgen für Frontend-Backend-Schnittstellen.
Standardisierung von Datenstrukturen in komplexen Daten-Engineering-Projekten.
Schnelle Konvertierung von unstrukturierten JSON-Logs in validierbare Datenmodelle.

Beispiele

1. API-Payload Dokumentation

Backend-Entwickler
Hintergrund
Ein Entwickler muss für einen neuen Endpunkt eine Dokumentation erstellen, hat aber nur ein Beispiel-JSON der Antwort.
Problem
Manuelle Erstellung des Schemas ist fehleranfällig und zeitaufwendig.
Verwendung
Beispiel-JSON einfügen, 'Gängige Formate erkennen' aktivieren und das generierte Schema als Basis für die API-Dokumentation kopieren.
Ergebnis
Ein präzises, validiertes JSON-Schema, das direkt in die API-Spezifikation übernommen werden kann.

2. Datenvalidierung für Microservices

Data Engineer
Hintergrund
Daten fließen zwischen verschiedenen Diensten und müssen strikt validiert werden.
Problem
Unklare Datenstrukturen führen zu Laufzeitfehlern in den nachgelagerten Diensten.
Verwendung
JSON-Beispiel hochladen, Schema generieren, manuell um 'required'-Felder ergänzen und die Validierung gegen das Beispiel ausführen.
Ergebnis
Ein robustes Schema, das als Validierungs-Layer für eingehende API-Anfragen dient.

Mit Samples testen

json

Verwandte Hubs

FAQ

Welche JSON-Schema-Versionen werden unterstützt?

Das Tool unterstützt aktuell die Versionen 2020-12 sowie Draft-07.

Kann ich das generierte Schema manuell bearbeiten?

Ja, Sie können das Schema im Feld 'Angepasstes Schema-JSON' bearbeiten und anschließend gegen das Beispiel validieren.

Was bewirkt die Option 'Enum aus Arrays ableiten'?

Wenn diese Option aktiviert ist, erkennt das Tool wiederkehrende Werte in Arrays und erstellt daraus ein Enum-Feld im Schema.

Werden Datumsformate oder E-Mails automatisch erkannt?

Ja, bei aktivierter Option 'Gängige Formate erkennen' werden Felder wie E-Mail-Adressen oder Datumsangaben automatisch mit entsprechenden 'format'-Attributen versehen.

Ist die Validierung verpflichtend?

Nein, die Validierung ist optional, hilft aber dabei, Fehler in der Schema-Definition frühzeitig zu erkennen.

API-Dokumentation

Request-Endpunkt

POST /de/api/tools/json-schema-generator

Request-Parameter

Parameter-Name Typ Erforderlich Beschreibung
sampleJson textarea Ja -
draft select Nein -
inferEnums checkbox Nein -
detectFormats checkbox Nein -
adjustedSchemaJson textarea Nein -
validateAdjustedSchema checkbox Nein -

Antwortformat

{
  "key": {...},
  "metadata": {
    "key": "value"
  },
  "error": "Error message (optional)",
  "message": "Notification message (optional)"
}
JSON-Daten: JSON-Daten

MCP-Dokumentation

Fügen Sie dieses Tool zu Ihrer MCP-Server-Konfiguration hinzu:

{
  "mcpServers": {
    "elysiatools-json-schema-generator": {
      "name": "json-schema-generator",
      "description": "Leitet JSON Schema aus Beispiel-JSON ab und unterstuetzt manuelle Anpassung sowie Validierung",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=json-schema-generator",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

Sie können mehrere Tools verketten, z.B.: `https://elysiatools.com/mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp`, maximal 20 Tools.

Wenn Sie auf Probleme stoßen, kontaktieren Sie uns bitte bei [email protected]