Начало работы
Начало работыВведение в клиент Voyager

Введение в клиент Voyager

Gato GraphQL предоставляет клиент GraphQL Voyager для интерактивной визуализации схемы GraphQL. Откройте его, нажав «Interactive Schema» в меню плагина:

Клиент GraphQL Voyager

Voyager даёт обзорный вид всей схемы GraphQL с высоты птичьего полёта:

Визуализация схемы для запроса данных

Он позволяет легко понять, как все элементы схемы связаны между собой, используя стрелки для отображения связей между типами:

Элементы схемы

Схема имеет отправную точку, то есть тип, от которого рассчитываются все связи. По умолчанию это корень queries (в данном случае обрабатываемый через тип QueryRoot), который отображается на плавающей панели внизу. Чтобы визуализировать схему в отношении мутаций, можно выбрать соответствующий корневой тип мутации (в данном случае MutationRoot):

Типы GraphQL на плавающей панели

Переключение вида с другого типа GraphQL

Переключено на вид от корня мутаций

Клик по типу в схеме выделит его связи и отобразит метаданные его полей (то же самое происходит при нажатии на название типа на левой боковой панели):

Выделение типа

Поле поиска на левой боковой панели позволяет фильтровать элементы схемы:

Фильтрация элементов схемы

Клик по связи выделит её как в схеме, так и на левой боковой панели:

Выделение связи

Для навигации по графу можно использовать мышь (и, в некоторой мере, кнопки в правом нижнем углу экрана): приближать и отдалять, перемещаться в любом направлении и фокусироваться на элементах:

Навигация по графу

На плавающей панели внизу доступны несколько дополнительных опций:

  • «Sort by alphabet» — сортирует все поля в каждом типе по алфавиту
  • «Skip Relay» — удаляет классы-обёртки Relay
  • «Skip deprecated» — скрывает все устаревшие поля
  • «Show leaf fields» — отображает все поля, не являющиеся связями

Дополнительные опции