Основные выводы
- 01Форматирует запросы, мутации, подписки и SDL схемы, используя официальный парсер graphql.js.
- 02Проверяет синтаксис и сообщает точные строки и столбцы для ошибок — никакая схема не требуется.
- 03Комментарии GraphQL (#) удаляются при форматировании; используйте строки описания для документации, которую вы хотите сохранить.
- 04Работает полностью в вашем браузере — внутренние запросы API и проприетарные схемы остаются приватными.
Почему форматировать документы GraphQL?
GraphQL запросы быстро могут усложниться — вложенные фрагменты, встроенные переменные, несколько определений операций и определения типов SDL с интерфейсами и директивами. Последовательное форматирование делает обзор сверстников быстрее и облегчает точечные пропущенные закрывающие скобки или несоответствия аргументов с первого взгляда.
Форматер использует парсер ссылки graphql.js — тот же парсер, который поставляется спецификация GraphQL. Это означает, что каноническое форматирование, которое вы получаете здесь, совпадает с тем, что производит плагин Prettier GraphQL и большинство инструментов GraphQL. Все, что разбирается чисто здесь, будет разбираться чисто в Apollo, Relay и graphql-request.
Как форматировать документ GraphQL
- 01
Вставьте ваш GraphQL
Вставьте запрос, мутацию, подписку, фрагмент или определение SDL схемы на входную панель.
- 02
Нажмите Format
Парсер выпускает документ с канонической отступом — двупробельный отступ, одно поле за строку, согласованное выравнивание аргументов. Результат появляется на выходной панели.
- 03
Опционно проверьте
Нажмите Validate, чтобы подтвердить документ разбирается без создания отформатированного вывода. Результат — подтверждение или список ошибок синтаксиса с номерами строк и столбцов.
- 04
Скопируйте результат
Нажмите Копировать, чтобы получить отформатированный документ. Вставьте его в вашу базу кода, описание PR или файл документации.
Безопасно для внутренних схем и запросов API
Парсер graphql.js работает полностью в вашем браузере. Никакой текст операции или определение схемы не отправляется на какой-либо сервер. Это делает его безопасным для форматирования запросов, которые ссылаются на приватные названия полей или внутренние системы типов, которые вы не хотите выставить третьему лицу инструментам.
Проверка здесь только синтаксическая — инструмент проверяет, что документ — это действительный документ GraphQL, но это не проверяет, существуют ли названия полей в реальной схеме, совпадают ли переменные с типами аргументов или правильно ли применяются директивы. Проверка, осведомленная схемой, требует целевой схемы, загружаемой вместе с документом.
Часто задаваемые вопросы о форматере GraphQL
Проверяет ли форматирование GraphQL против схемы?
Нет — только проверка синтаксиса. Проверка того, существуют ли поля и аргументы, требует целевой схемы. Этот инструмент подтверждает документ — это действительный документ GraphQL, ничего больше.
Будут ли комментарии в моем GraphQL сохранены?
Нет. Строки, начинающиеся с #, удаляются парсером. Используйте строки описания в тройных кавычках для документации, которая должна выжить при форматировании.
Какая версия спецификации GraphQL поддерживается?
Спецификация October 2021 года, включая OneOf входные объекты и директиву @specifiedBy.
Могу ли я форматировать определения SDL схемы, а не только документы операций?
Да. Определения типов, объявления интерфейсов, типы объединений, перечисления, директивы и описания все правильно округлого путешествия через форматер.
Загружается ли запрос или схема где-либо?
Нет. Парсер graphql.js работает полностью в вашем браузере — ничего не покидает ваше устройство.