← Аналитика / analytics / graphql-api / getting-started

Изучите схему GraphQL

Многие клиенты GraphQL позволяют просматривать схему GraphQL, беря на себя заботу о интроспекция. На этой странице речь пойдёт о клиентах GraphiQL и Altair.

GraphiQL ↗ и Altair ↗ это клиенты GraphQL с открытым исходным кодом, которые предоставляют инструмент для составления запроса, его выполнения и просмотра результатов. Кроме того, они позволяют просматривать схему GraphQL.

Прежде чем начать, не забудьте настроить конечную точку API и заголовки HTTP.

Приведённые ниже снимки экрана сделаны в GraphiQL. Однако Altair предоставляет ту же функциональность, и вы без труда сможете изучить схему, следуя тем же инструкциям.

Чтобы открыть GraphiQL Documentation Explorer, выберите Документация ссылка в заголовке панели ответа:

Documentation Explorer откроется и покажет список доступных объектов:

Объекты в Documentation Explorer используйте такой синтаксис:

  object-name: object-type-definition

При первом открытии Documentation Explorer панели, mutation и query корневые типы отображают:

В этом примере query является именем корня, а Query является определением типа.

Нажмите на определение типа узла и посмотреть поля, которые он предоставляет. Documentation Explorer также отображает описания узлов.

Например, выберите Запрос определение типа. Documentation Explorer отображает поля, которые Query предоставляет. В этом примере поля: cost и viewer:

Чтобы изучить схему, выбирайте имена объектов и определений. Также можно использовать поле поиска (значок лупы) и ссылки навигационной цепочки в заголовке.

Нажмите на определение типа viewer поле (выделено золотым цветом), чтобы отобразить его подполя. viewer поле предоставляет подполя, которые позволяют выполнять запрос к accounts или zones данные:

accounts и zones узлы принимают аргументы, которые определяют, к какому датасету обращается запрос.

Например, zones может принимать фильтр ZoneFilter_InputObject тип в качестве аргумента. Чтобы увидеть поля, доступные для фильтрации, выберите ZoneFilter_InputObject.

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

Список наборов данных отображается в Поля раздел, каждая из которых содержит список допустимых аргументов и краткое описание. Аргументы, оканчивающиеся восклицательным знаком (!) обязательны.

Чтобы найти нужные наборы данных, используйте поле поиска (значок лупы):

Чтобы выбрать набор данных, выберите его имя.

Отображается описание набора данных. Этот пример показывает firewallEventsAdaptive набор данных:

Чтобы просмотреть поля, доступные для конкретного набора данных, выберите его определение типа (текст золотого цвета).

Например, выберите ZoneFirewallEventsAdaptive определение типа, чтобы увидеть поля, доступные для firewallEventsAdaptive набор данных:

Отображается список полей:

Подробности об использовании GraphiQL см. на этой руководство.