Как пользоваться: GraphQL форматтер и валидатор
- Вставьте GraphQL-запрос, мутацию, подписку, фрагмент или схему (SDL).
- Код форматируется по мере ввода; синтаксические ошибки показывают строку и столбец.
- При необходимости откройте Проверка по схеме и вставьте свой SDL, чтобы проверить каждое поле и аргумент.
- Скопируйте отформатированный или минифицированный результат.
Что проверяет валидатор
Без схемы инструмент проверяет синтаксис: сбалансированность фигурных скобок, корректность имён, синтаксис аргументов и переменных, экранирование строк и блочных строк. Если схема добавлена, запускается полный набор правил валидации GraphQL из спецификации — тех же правил, которые сервер GraphQL применяет перед выполнением запроса:
- Каждое поле существует в своём типе; листовые поля (скаляры, перечисления) не имеют вложенного набора полей, а поля-объекты его требуют.
- Аргументы существуют, обязательные аргументы переданы, а значения соответствуют типу.
- Переменные объявлены и используются, а их типы подходят к месту использования.
- Фрагменты используются, соответствуют типу, на который ссылаются, и не образуют циклов.
- Имена операций уникальны, а анонимная операция встречается только одна.
Форматирование и минификация
Форматирование использует эталонную функцию print из graphql-js, поэтому результат совпадает с тем, что выдаёт большинство инструментов для GraphQL: отступ в два пробела, одно поле на строку и единообразные пробелы в аргументах. Минификация удаляет комментарии и незначащие пробелы — это полезно для GET-запросов и persisted queries, где важен каждый байт. Нужно собрать запрос по схеме? Воспользуйтесь конструктором GraphQL-запросов.
Также ищут как: sdl форматтер.
Инструменты, которые хорошо сочетаются с GraphQL форматтер и валидатор
- JSON форматтер — Вставьте JSON, чтобы отформатировать, минифицировать или проверить его.
- Валидатор OpenAPI / Swagger — Вставьте спецификацию API, чтобы проверить её по официальной схеме OpenAPI, найти битые ссылки и несогласованные параметры пути и увидеть все эндпоинты сразу.
- Валидатор JSON Schema — Вставьте схему и JSON, чтобы увидеть, какие значения нарушают какие правила, или сгенерируйте стартовую схему по примеру данных.
- Тестер вебхуков — Получите уникальный URL, направьте на него любой вебхук или HTTP-клиент и смотрите, как запросы приходят в реальном времени: заголовки, строка параметров и тело в читаемом виде, а также проверка подписи HMAC.
Часто задаваемые вопросы
Поддерживаются ли файлы схем (SDL)?
Можно ли загрузить схему с эндпоинта?
rover graph introspect, get-graphql-schema или из кода вашего сервера.