Sprawdź i sformatuj zapytanie GraphQL

Programiści formatują i sprawdzają zapytania GraphQL przed przeglądem kodu, debugowaniem lub wysłaniem ich do interfejsu API.

Sprawdź i sformatuj zapytanie GraphQL, aby ułatwić przegląd, edycję i wyszukiwanie błędów. Działa bezpłatnie w przeglądarce, bez zakładania konta.

Jak używać

Wklej zapytanie GraphQL do obszaru wprowadzania lub zaimportuj plik .graphql albo .gql.
Sprawdź, czy zapytanie jest kompletne i czy nawiasy klamrowe są zrównoważone, zanim rozpoczniesz formatowanie.
Uruchom formater, aby wciąć zapytanie i wychwycić możliwy błąd składni.
Porównaj dane wyjściowe z oryginałem, aby upewnić się, że znaczenie zapytania się nie zmieniło.
Wyczyść zawartość przed przejściem do kolejnego zapytania lub pliku.

Przykład

Programista wkleja zapytanie odczytu z kilkoma zagnieżdżonymi polami, a następnie formatuje je przed przeglądem. Sprawdza, czy pola zachowują tę samą kolejność logiczną i czy wcięcia ułatwiają odczyt każdego bloku.

Ograniczenia i formaty

Narzędzie formatuje i waliduje składnię GraphQL; nie wykonuje zapytania ani nie łączy się z żadnym API.
Nie zna Twojego schematu, więc dobrze wcięte zapytanie nadal może żądać pól, które nie istnieją.
Import obsługuje formaty takie jak .graphql, .gql, .json, .html, .css, .js, .ts, .sql oraz pliki tekstowe, ale zawartość nadal musi być prawidłowym GraphQL.
Po formatowaniu przeczytaj ponownie fragmenty, zmienne i dyrektywy, aby potwierdzić, że nic ważnego nie zostało wizualnie zmienione.

Gdzie odbywa się przetwarzanie

Formatowanie odbywa się lokalnie w Twojej przeglądarce. Wklejone lub zaimportowane zapytanie nie jest wysyłane na zewnątrz i pozostaje na Twoim urządzeniu podczas operacji. Możesz przygotować przegląd kodu lub poprawić wcięcia bez zakładania konta.

Częste pytania

Czy narzędzie waliduje względem mojego schematu?

Nie, działa na składni zapytania. Może oznaczyć niepoprawny zapis, ale nie wie, czy pola istnieją w Twoim schemacie ani czy typy pasują do Twojego API.

Czy mogę sformatować mutację lub subskrypcję?

Tak, o ile tekst jest zgodny ze składnią GraphQL. Formatowanie dotyczy struktury zapytania, niezależnie od tego, czy jest to odczyt, mutacja czy subskrypcja, bez wykonywania operacji.

Dlaczego moje zapytanie nie zostało sformatowane?

Błąd składni, brakujący znak lub zawartość, która nie jest GraphQL, mogą uniemożliwić czysty wynik. Najpierw popraw oznaczoną część, a następnie uruchom formater ponownie na kompletnym zapytaniu.