GraphQL Formatierer
Füge eine unordentliche GraphQL-Query, Mutation oder ein Schema ein und erhalte sauberen, einheitlich eingerückten Code oder einen minifizierten Einzeiler. Alles läuft vollständig in deinem Browser, private APIs und Schemas verlassen dein Gerät also nie.
Zuletzt aktualisiert:
Tipp: Drücke Strg + Eingabe im Eingabefeld, um zu formatieren. Alles läuft in deinem Browser; dein Schema verlässt diese Seite nie.
Anleitung: GraphQL Formatierer
- Füge deine GraphQL-Query, Mutation, dein Fragment oder Schema in das Eingabefeld ein oder öffne eine .graphql-Datei.
- Wähle die Einrückung (2 Leerzeichen, 4 Leerzeichen oder Tabs) und ob #-Kommentare erhalten bleiben sollen.
- Klicke auf GraphQL formatieren (oder Strg + Eingabe). Ist „Beim Tippen formatieren“ aktiviert, wird die Ausgabe während der Bearbeitung aktualisiert.
- Behebe Fehler: Ist die Syntax ungültig, siehst du Zeile und Spalte mit einem Zeiger; klicke auf In Eingabe zeigen, um direkt dorthin zu springen.
- Kopiere oder lade das Ergebnis herunter oder klicke auf Minifizieren, um eine kompakte einzeilige Version für Requests zu erhalten.
Vor und nach dem Formatieren
GraphQL ignoriert Leerraum und Kommas, daher sind Queries aus Logs, Netzwerk-Tabs oder Codegeneratoren oft eine einzige dichte Zeile. Der Formatierer baut sie mit einem Feld pro Zeile und einer Einrückungsebene pro Selection Set neu auf:
| Eingabe | Formatiert |
|---|---|
query($id:ID!){user(id:$id){name,posts(first:5){title}}} | query($id: ID!) { user(id: $id) { name posts(first: 5) { title … |
GraphQL-Syntax-Spickzettel
| Konstrukt | Beispiel | Hinweise |
|---|---|---|
| Alias | small: avatar(size: 32) | Benennt ein Feld in der Antwort um; so kannst du dasselbe Feld zweimal abfragen. |
| Variablen | query Q($first: Int = 10) | Typisiert, optionaler Standardwert; ! kennzeichnet einen Pflichttyp (non-null). |
| Fragment | fragment F on User { id } und ...F | Wiederverwendbares Selection Set mit Typbedingung. |
| Inline-Fragment | ... on Admin { permissions } | Wählt Felder nur für einen konkreten Typ eines Interface oder einer Union aus. |
| Direktiven | @include(if: $x), @skip und @deprecated | Annotieren Felder, Fragmente, Operationen oder Schema-Elemente. |
| Input-Objektwert | orderBy: { field: NAME, direction: ASC } | Bleibt inline; Enums werden ohne Anführungszeichen geschrieben. |
| Blockstring | """Mehrzeilige Beschreibung""" | Gemeinsame Einrückung wird entfernt, damit der Formatierer sie sicher neu einrücken kann. |
| Kommentar | # note | Reicht bis zum Zeilenende; wird vom Server ignoriert. |
Häufige GraphQL-Syntaxfehler
- Expected Name, found "}": ein leeres Selection Set wie
user { }oder ein fehlendes Feld nach einem Komma oder Alias-Doppelpunkt. - Expected "on": Eine Fragment-Definition braucht eine Typbedingung, zum Beispiel
fragment UserFields on User. - Unterminated string: Ein normaler
"string"darf nicht über mehrere Zeilen gehen; verwende stattdessen einen"""block string""". - Unexpected character: Typografische Anführungszeichen (“ ”) aus Dokumenten oder Chat-Apps sind ungültig. Ersetze sie durch gerade Anführungszeichen.
- Variables are not allowed in constant values: Standardwerte und Direktiven in einem Schema können keine
$variablesverwenden.
Arbeitest du auch mit den JSON-Antworten? Räume sie mit dem JSON Formatierer auf oder vergleiche zwei Versionen eines Schemas mit dem Code-Diff-Checker.
Häufige Fragen
Sendet dieser GraphQL-Formatierer meine Query oder mein Schema an einen Server?
Nein. Tokenizer, Parser und Printer sind reines JavaScript, das in deinem Browser-Tab läuft. Nichts, was du einfügst, wird hochgeladen oder gespeichert, daher ist er auch für interne Schemas und Queries mit IDs sicher.
Prüft er meine Query gegen ein Schema?
Er prüft nur die GraphQL-Syntax: Klammern, Strings, Namen, Argumente, Direktiven und den Aufbau der Definitionen gemäß der Grammatik der GraphQL-Spezifikation. Das Schema deines Servers kennt er nicht, daher kann er dir nicht sagen, dass ein Feld oder Typ nicht existiert.
Kann er SDL-Schemadateien formatieren?
Ja. Definitionen für type, interface, input, enum, union, scalar, schema und directive werden unterstützt, ebenso extend type und andere Erweiterungen, Beschreibungen in Anführungszeichen oder dreifach zitierten Blockstrings, implements A & B, Standardwerte und repeatable-Direktiven.
Was passiert mit Kommas in GraphQL?
In GraphQL sind Kommas bedeutungslos, genau wie Leerraum. Der Formatierer trennt Inline-Argumente und Listenelemente zur besseren Lesbarkeit mit Komma und Leerzeichen und entfernt sie, wenn Argumente auf mehrere Zeilen verteilt werden oder wenn du minifizierst.
Bleiben Kommentare erhalten?
Ja, #-Kommentare bleiben in einer eigenen Zeile vor dem Element, vor dem sie stehen, und ein Kommentar am Zeilenende bleibt am Ende dieser Zeile. Deaktiviere #-Kommentare behalten, um sie zu entfernen. Beim Minifizieren werden Kommentare immer entfernt, da der Server sie nicht braucht.
Warum sollte man eine GraphQL-Query minifizieren?
Eine minifizierte Query ist kleiner in HTTP-Requests, Persisted-Query-Maps und URLs für GET-Requests. Der Server parst sie genau wie die formatierte Version, denn Leerraum, Kommas und Kommentare haben keine Bedeutung.
Wie werden lange Zeilen behandelt?
Würden die Argumente eines Felds, die Variablen einer Operation oder die Argumente einer Felddefinition eine Zeile länger als 80 Zeichen machen, kommt jedes Element in eine eigene Zeile, ähnlich wie bei Prettier und graphql-js print.
Werden alle Tools auf FreeToolCabin auf Qualität und Genauigkeit getestet?
Ja. Jedes Tool auf der Website durchläuft automatische Tests in echten Browsern, die prüfen, ob das Ergebnis stimmt und keine Fehler auftreten. Wenn du einen Fehler findest oder einen Vorschlag hast, schreib uns an [email protected] – wir sehen es uns an.