GraphQL-Abfrage einrücken und prüfen

Entwicklerinnen und Entwickler nutzen GraphQL-Formatierer vor Code-Review, Fehlersuche oder Übergabe an andere Beteiligte.

Rücken Sie eine GraphQL-Abfrage ein und prüfen Sie sie, damit Bearbeitung und Fehlersuche leichter werden. Direkt im Browser nutzbar, ohne Anmeldung.

Bedienung

Fügen Sie Ihre GraphQL-Abfrage in den Eingabebereich ein oder importieren Sie eine Datei mit der Endung .graphql oder .gql.
Prüfen Sie vor dem Formatieren, dass die Abfrage vollständig und die geschweiften Klammern ausgeglichen sind.
Starten Sie den Formatierer, um die Abfrage einzurücken und einen möglichen Syntaxfehler zu erkennen.
Vergleichen Sie die Ausgabe mit dem Original, um sicherzustellen, dass sich die Bedeutung der Abfrage nicht geändert hat.
Leeren Sie den Inhalt, bevor Sie mit einer anderen Abfrage oder Datei fortfahren.

Beispiel

Ein Entwickler fügt eine Leseabfrage mit mehreren verschachtelten Feldern ein und formatiert sie dann vor einer Überprüfung. Er prüft, ob die Felder dieselbe logische Reihenfolge beibehalten und ob die Einrückung jeden Block leichter lesbar macht.

Grenzen und Formate

Das Werkzeug formatiert und validiert die GraphQL-Syntax; es führt die Abfrage nicht aus und kontaktiert keine API.
Es kennt Ihr Schema nicht, daher kann eine gut eingerückte Abfrage weiterhin Felder anfordern, die nicht existieren.
Der Import unterstützt Formate wie .graphql, .gql, .json, .html, .css, .js, .ts, .sql und Textdateien, aber der Inhalt muss weiterhin gültiges GraphQL sein.
Lesen Sie nach dem Formatieren Fragmente, Variablen und Direktiven erneut, um zu bestätigen, dass nichts Wichtiges optisch verändert wurde.

Wo die Verarbeitung stattfindet

Die Formatierung erfolgt lokal in Ihrem Browser. Die Abfrage, die Sie einfügen oder importieren, wird nicht nach außen gesendet und bleibt während des Vorgangs auf Ihrem Gerät. Sie können eine Codeüberprüfung vorbereiten oder die Einrückung korrigieren, ohne ein Konto zu erstellen.

Häufige Fragen

Validiert es gegen mein Schema?

Nein, es arbeitet mit der Syntax der Abfrage. Es kann fehlerhafte Schreibweise melden, weiß aber nicht, ob Felder in Ihrem Schema existieren oder ob Typen zu Ihrer API passen.

Kann ich eine Mutation oder Subscription formatieren?

Ja, solange der Text der GraphQL-Syntax folgt. Die Formatierung gilt für die Struktur der Abfrage, ob es sich um eine Leseabfrage, eine Mutation oder eine Subscription handelt, ohne den Vorgang auszuführen.

Warum wird meine Abfrage nicht formatiert?

Ein Syntaxfehler, ein fehlendes Zeichen oder Inhalt, der kein GraphQL ist, können ein sauberes Ergebnis verhindern. Korrigieren Sie zuerst den markierten Teil und führen Sie den Formatierer dann erneut mit einer vollständigen Abfrage aus.