GraphQL formatieren
GraphQL formatieren oder minimieren: Querys, Fragmente und GraphQL-Schemas werden sauber eingerückt oder auf eine Zeile verkürzt, mit Prüfung der Klammern.
Alles läuft in Ihrem Browser. Eingaben verlassen Ihr Gerät nicht.
GraphQL Formatter für Querys und Schemas
Mit diesem Werkzeug können Sie GraphQL formatieren: Querys, Mutations, Subscriptions und Fragmente werden sauber eingerückt, jedes Feld steht in einer eigenen Zeile, Argumente bleiben kompakt in Klammern. Der GraphQL Formatter versteht auch die Schemasprache (SDL), also ein GraphQL-Schema mit type, input, enum, interface, union, scalar und directive, samt Beschreibungen in Anführungszeichen und Block-Strings. Kommentare mit # bleiben erhalten.
Die Umkehrung ist GraphQL minimieren: Alle Zeilenumbrüche, Einrückungen, Kommentare und die in GraphQL bedeutungslosen Kommas werden entfernt, sodass die Query in eine Zeile passt, zum Beispiel für einen GET-Parameter, ein Shell-Skript oder einen JSON-Body. Dabei bleiben nur die Leerzeichen stehen, die zwei Namen trennen. Beim Query formatieren und beim Minimieren prüft das Werkzeug außerdem, ob alle geschweiften, runden und eckigen Klammern zueinander passen und Zeichenketten geschlossen sind, und nennt bei einem Fehler die Zeile.
Das Werkzeug ist ein Formatierer, keine vollständige Prüfung gegen ein Schema: Ob ein Feld existiert oder ein Argument den richtigen Typ hat, kann nur Ihr GraphQL-Server oder ein Werkzeug mit Zugriff auf das Schema sagen. Die Formatierung lehnt sich an verbreitete Konventionen an, ist aber nicht in jedem Detail mit Prettier identisch. Variablen für die Query schreiben Sie als JSON, das Sie mit JSON formatieren prüfen können.
Anleitung: GraphQL formatieren in 4 Schritten
- Die GraphQL-Query oder das Schema einfügen oder mit „Beispiel Query“ bzw. „Beispiel Schema“ eine Vorlage laden.
- Die Aktion wählen: Formatieren oder Minimieren.
- Die Einrückung (2 Leerzeichen, 4 Leerzeichen oder Tabulator) festlegen und entscheiden, ob Kommentare erhalten bleiben.
- Das Ergebnis kopieren oder mit „Ergebnis als Eingabe“ weiterbearbeiten.
Typische Anwendungsfälle
- Query aus dem Netzwerk-Tab lesen: Eine einzeilige Anfrage aus den Entwicklerwerkzeugen lesbar einrücken.
- Query für curl oder JSON: Eine Query minimieren, damit sie in einen JSON-Body oder ein Shell-Skript passt.
- Schema aufräumen: Eine GraphQL-Schema-Datei vor dem Code-Review einheitlich formatieren.
- Syntaxfehler finden: Eine offene Klammer oder Zeichenkette in einer langen Query mit Zeilenangabe aufspüren.
Häufige Fragen
Was unterstützt der GraphQL Formatter?
Querys, Mutations, Subscriptions, Fragmente, Inline-Fragmente, Variablen mit Standardwerten, Direktiven wie @include und @skip sowie die Schemasprache mit type, input, enum, interface, union, scalar, schema, directive und extend.
Warum verschwinden die Kommas?
In GraphQL sind Kommas bedeutungslos und werden wie Leerzeichen behandelt. Der Formatierer setzt sie zwischen Argumenten und Listenwerten neu, damit sie gut lesbar sind; beim Minimieren entfallen sie ganz.
Prüft das Werkzeug, ob meine Query gültig ist?
Es prüft die Syntax auf Ebene der Zeichen: passende Klammern, geschlossene Zeichenketten, gültige Zeichen. Ob Felder und Typen zum Schema Ihres Servers passen, kann es nicht wissen.
Wann lohnt es sich, GraphQL zu minimieren?
Wenn die Query in eine URL, eine Umgebungsvariable oder einen JSON-String passen soll. Für die Übertragung im Body bringt es wenig, weil HTTP-Kompression Leerzeichen ohnehin gut verkleinert.
Werden meine Querys übertragen?
Nein. Das Formatieren läuft nur in Ihrem Browser.
Wie sende ich eine GraphQL-Query mit curl?
Als POST mit JSON-Body, in dem die Query als Zeichenkette steht: curl -X POST -H "Content-Type: application/json" -d '{"query":"{ viewer { login } }"}' https://api.example.com/graphql. Eine minimierte Query passt dabei am einfachsten in den Body.
Was ist der Unterschied zwischen Query und Mutation?
Eine Query liest Daten, eine Mutation ändert sie, etwa beim Anlegen oder Löschen eines Eintrags. Beide werden gleich geschrieben und lassen sich hier gleich formatieren.
Das könnte auch helfen
JSON minimieren
JSON auf eine Zeile verdichten: Leerraum entfernen, Zahlen exakt erhalten, optional Schlüssel sortieren.
ÖffnenJSON in CSV umwandeln
JSON-Arrays in CSV für Excel umwandeln: verschachtelte Felder als Spalten, Semikolon oder Komma.
ÖffnenCSV in JSON umwandeln
CSV in JSON umwandeln mit automatischer Trennzeichen-Erkennung und Anführungszeichen nach RFC 4180.
ÖffnenXML formatieren und prüfen
XML einrücken, minimieren und auf Wohlgeformtheit prüfen, mit Fehlerstelle in Zeile und Spalte.
ÖffnenXML in JSON umwandeln
XML in JSON umwandeln: Attribute mit Präfix, wiederholte Elemente als Arrays, Zahlen erkannt.
ÖffnenYAML in JSON umwandeln
YAML prüfen und in JSON umwandeln: Listen, Anker, Block-Strings und mehrere Dokumente.
Öffnen