Форматтер GraphQL
Форматируйте запросы, мутации, фрагменты и схемы GraphQL с помощью этого форматтера GraphQL. Вставьте документ: инструмент разберёт его с помощью парсера GraphQL и выведет в стандартном формате: отступ в два пробела, одно поле на строку, без запятых между полями, с единообразными пробелами в аргументах и переменных. О синтаксических ошибках сообщается отдельно, поэтому разработчики API получают понятные операции и SDL для документации, проверки кода и отладки.
Часто задаваемые вопросы
Как работает форматировщик GraphQL?
Он разбирает документ в синтаксическое дерево GraphQL и выводит его в стандартном формате. Поскольку документ разбирается, некорректный GraphQL отклоняется, а не форматируется неправильно.
Что можно форматировать?
Запросы, мутации, подписки и фрагменты, а также определения схемы в SDL, например блоки type, input, enum, interface, union и schema. В одном документе можно объединить несколько определений.
Как выглядит результат?
Каждый набор выборок имеет отступ в два пробела, поля размещаются по одному в строке, а запятые между полями удаляются. После каждого двоеточия в аргументах и определениях переменных добавляется пробел, например user(id: $id).
Что произойдет при ошибке синтаксиса?
Инструмент останавливается и показывает сообщение парсера, например Syntax Error: Expected Name, found }. Исправьте указанное место и запустите форматирование снова.
Комментарии сохраняются?
Форматтер сохраняет комментарии с решёткой (#) там, где парсер может их присоединить, например после закрывающей фигурной скобки. Описания в кавычках для типов схемы и полей являются частью документа и всегда сохраняются.
Проверяет ли он мой запрос по схеме?
Нет, он проверяет только синтаксис. Наличие полей и аргументов определяется схемой вашего сервера, поэтому используйте клиент или сервер GraphQL для проверки.
Можно ли форматировать строку запроса, скопированную из JavaScript?
Вставьте только документ GraphQL без внешних кавычек, обратных кавычек или тега gql. Сначала необходимо снять экранирование со специальных символов в данных JSON.
Можно ли изменить отступ?
Нет, форматировщик всегда использует два пробела и не имеет настроек. Это соответствует формату, который используют большинство инструментов и документации GraphQL.
Почему результат заключен в блок кода graphql?
Результат возвращается как блок кода Markdown с пометкой graphql, поэтому в Markdown он отображается с подсветкой. Скопируйте строки между ограждениями в файл .graphql.
Каков максимальный размер документа?
До 5 MB за один запуск; более крупный ввод отклоняется с сообщением. Результат идентичен варианту GraphQL форматировщика кода.