Formatter GraphQL
Formatuj zapytania GraphQL, mutacje, fragmenty i schematy za pomocą tego formattera GraphQL. Wklej dokument, a narzędzie przeanalizuje go za pomocą parsera GraphQL i wyświetli w standardowym układzie: wcięcia po dwie spacje, jedno pole w wierszu, usunięte przecinki między polami oraz spójne odstępy przy argumentach i zmiennych. Błędy składni są zgłaszane, dzięki czemu deweloperzy API otrzymują czytelne operacje i SDL do dokumentacji, przeglądów i debugowania.
Najczęściej zadawane pytania
Jak działa formatter GraphQL?
Analizuje dokument, tworząc drzewo składniowe GraphQL, a następnie drukuje go ponownie w standardowym układzie. Ponieważ dokument jest analizowany, nieprawidłowy GraphQL zostaje odrzucony zamiast błędnie sformatowany.
Co mogę formatować?
Zapytania, mutacje, subskrypcje i fragmenty, a także definicje schematu w SDL, takie jak bloki type, input, enum, interface, union i schema. W jednym dokumencie można łączyć kilka definicji.
Jak wygląda wynik?
Każdy zestaw wyboru jest wcięty o dwie spacje, a każde pole znajduje się w osobnym wierszu; przecinki między polami są usuwane. Po każdym dwukropku w argumentach i definicjach zmiennych dodawana jest spacja, na przykład user(id: $id).
Co się stanie w przypadku błędu składni?
Narzędzie zatrzymuje działanie i wyświetla komunikat parsera, na przykład Syntax Error: Expected Name, found }. Popraw wskazane miejsce i ponownie sformatuj dokument.
Czy komentarze są zachowywane?
Formatter zachowuje komentarze rozpoczynające się od kratki (#) tam, gdzie parser może je przypisać, na przykład po nawiasie klamrowym zamykającym. Opisy ujęte w cudzysłów przy typach i polach schematu są częścią dokumentu i zawsze są zachowywane.
Czy narzędzie sprawdza poprawność mojego zapytania względem schematu?
Nie, sprawdza tylko składnię. To, czy pola i argumenty istnieją, określa schemat serwera, dlatego do walidacji użyj klienta lub serwera GraphQL.
Czy mogę sformatować ciąg zapytania skopiowany z JavaScript?
Wklej tylko dokument GraphQL, bez otaczających go cudzysłowów, znaków backtick ani tagu gql. Znaki specjalne z ładunku JSON należy najpierw odkodować.
Czy mogę zmienić wcięcia?
Nie, formatter zawsze używa dwóch spacji i nie ma żadnych opcji. Taki układ stosuje większość narzędzi i dokumentacji GraphQL.
Dlaczego wynik jest otoczony blokiem kodu graphql?
Wynik jest zwracany jako blok kodu Markdown oznaczony jako graphql, dzięki czemu w Markdown jest wyświetlany z podświetlaniem składni. Skopiuj wiersze między znacznikami bloku do pliku .graphql.
Jak duży może być mój dokument?
Do 5 MB na jedno uruchomienie; większe dane wejściowe zostają odrzucone z komunikatem. Wynik jest identyczny z opcją GraphQL w narzędziu Code Formatter.