JSON Schema Generator

Der JSON Schema Generator verwandelt eine JSON-Stichprobe in ein validierungsbereites Schema für APIs, Webhooks, Konfigurationsdateien, Datenpipelines und Dokumentationen. Fügen Sie ein repräsentatives JSON-Objekt, ein Array oder einen NDJSON-Feed ein, wählen Sie den Ableitungsstil, und das Tool erstellt ein Schema mit geschachtelten Eigenschaften, Regeln für Array-Elemente, Nullable-Werten, Beispielen und lesbaren Hinweisen für jeden Pfad.

Warum einen stichprobenbasierten JSON Schema Generator verwenden?

Das Schreiben von JSON Schema von Hand ist präzise, aber langsam, insbesondere wenn die Daten geschachtelte Objekte, Arrays von Datensätzen, optionale Felder und Nullable-Werte enthalten. Dieser Generator liefert Ihnen einen strukturierten ersten Entwurf, der die beobachtete Struktur Ihrer JSON-Daten erfasst, und hebt hervor, wo eine menschliche Überprüfung noch erforderlich ist. Er ist nützlich für die API-Anforderungsvalidierung, Antwortverträge, OpenAPI-Arbeiten, Webhook-Payloads, Event-Streams und Konfigurationsschemas.

Bedienungsanleitung

1. Fügen Sie ein repräsentatives JSON-Objekt, ein JSON-Array oder durch Zeilenumbruch getrennte NDJSON-Datensätze in den Editor ein.
2. Wählen Sie den JSON Schema Draft und entscheiden Sie, ob erforderliche Felder, Beispiele, Enum-Hinweise, String-Formate und geschlossene Objekte abgeleitet werden sollen. Standardmäßig ist der Draft Draft 2020-12, erforderliche Felder sind auf In jedem Objekt vorhanden gesetzt, Format erkennen, Beispiele einschließen und Enum-Hinweise ableiten sind aktiviert, und Geschlossene Objekte ist deaktiviert. Der Schema-Titel lautet zu Beginn GeneratedSchema.
3. Klicken Sie auf JSON Schema generieren, um Typen, geschachtelte Eigenschaften, Array-Elemente, Nullable-Felder und Validierungshinweise abzuleiten.
4. Überprüfen Sie die generierte Übersicht, um jeden Pfad, den abgeleiteten Typ, den Pflichtfeld-Status, das Format und die Regel zu sehen, bevor Sie das Schema verwenden.
5. Kopieren Sie das generierte Schema und verfeinern Sie domänenspezifische Validierungsregeln wie exakte Bereiche, ID-Muster und geschäftsspezifische Enums.

Was der Generator ableitet

• JSON-Kerntypen: object, array, string, number, integer, boolean und null.
• Geschachtelte Objekteigenschaften und erforderliche Felder basierend darauf, was in jedem beobachteten Objekt vorkommt.
• Array-Element-Schemas durch Zusammenführen der beobachteten Elemente in der Stichprobe.
• Gängige String-Formate einschließlich E-Mail, URL, Datum, Datum-Uhrzeit, UUID, IPv4 und IPv6.
• Optionale Beispiele, Enum-Hinweise, beobachtete numerische Bereiche und beobachtete String-Längen.

FAQ

Was macht dieser JSON Schema Generator?

Er liest eine JSON-Stichprobe und erstellt ein JSON Schema, das die beobachtete Datenstruktur beschreibt. Der Generator leitet Objekteigenschaften, Arrays, primitive Typen, Nullable-Werte, Beispiele, Enum-Hinweise, erforderliche Felder und gängige String-Formate ab.

Kann ein generiertes Schema sofort in der Produktion verwendet werden?

Nutzen Sie es als starken Ausgangspunkt und überprüfen Sie es anschließend. Stichprobendaten können nicht jede Geschäftsregel kennen, daher müssen Sie möglicherweise noch Muster, exakte Bereiche, zulässige Enum-Werte, Versionsregeln und strengere additionalProperties-Einstellungen hinzufügen.

Welche JSON Schema Drafts werden unterstützt?

Das Tool kann Schemas für Draft 2020-12, Draft 2019-09 und Draft-07 generieren, indem es die $schema URI setzt. Die abgeleitete Struktur ist absichtlich mit gängigen Validatoren kompatibel.

Wie werden erforderliche Felder abgeleitet?

Wenn die Ableitung von Pflichtfeldern aktiviert ist, wird eine Eigenschaft nur dann als erforderlich markiert, wenn sie in jedem beobachteten Objekt auf dieser Ebene vorkommt. Für ein Array von Objekten bedeutet dies, dass das Feld in jedem Stichproben-Element enthalten sein muss.

Unterstützt das Tool Arrays von Objekten und NDJSON?

Ja. Ein JSON-Array auf oberster Ebene wird als Array-Schema behandelt, und durch Zeilenumbruch getrennte JSON-Datensätze werden als ein Array von Datensätzen behandelt. Die Eigenschaften der Elemente werden aus den beobachteten Stichproben zusammengeführt.