API Explorer

API Explorer — это IDE в браузере для изучения GraphQL API вашего проекта. Он позволяет разработчикам Archie Core легко создавать и выполнять GraphQL-запросы из рабочей области.

API Explorer использует ваши реальные производственные данные.

Интроспекция

Схема GraphQL имеет встроенную систему интроспекции, которая публикует структуру схемы. Это позволяет API Explorer предоставлять мощные функции автодополнения при написании GraphQL-запросов.

Внутри блока items введите “em”. Отсюда легко увидеть и выбрать поле email из доступных операций в API. Автодополнение контекстно зависит от того, где вы находитесь в создаваемом запросе, и фильтрует параметры на основе вводимого текста.

Чтобы вручную активировать меню автодополнения и просмотреть доступные параметры, нажмите комбинацию клавиш [Shift] + [SPACE]. Это действие отображает контекстное меню, позволяющее выбрать нужное поле, например items, из списка.

Кроме того, интроспекция помогает нам обнаруживать ошибки в запросах. Система распознает, когда разные типы недоступны или неправильно настроены. Поэтому при использовании API Explorer наведите курсор на красные волнистые линии, чтобы увидеть всплывающие подсказки об ошибках.

Документация

Еще один удобный способ изучить множество операций и типов GraphQL, доступных в текущей рабочей области, — использовать Документацию.

Доступ к документации API

API Explorer включает встроенную справку по схеме, которая поможет вам понять вашу модель данных при написании запросов.

1. Панель документации

Нажмите кнопку Documentation, расположенную в правом верхнем углу панели инструментов.

2. Контекстная быстрая навигация

Вы можете перейти непосредственно к документации для конкретного поля, которое вы вводите.

Композер

Композер — это визуальный инструмент для построения запросов, который обычно открыт по умолчанию в левой части API Explorer.

query MyQuery {
  cities {
    items {
      nameCity
    }
  }
}