Использование обозревателя

Сведения об обозревателе GraphQL

GraphiQL, также упоминаемый в этой документации как обозреватель GraphQL, является "графической интерактивной IDE GraphQL в браузере".

Автоматическое заполнение запросов

Для создания запросов можно использовать автозавершение запросов. В главной области в фигурных скобках запроса используйте пространство управления+или сместите+пространство для отображения меню автозаполнения.

Все типы в схеме GraphQL включают поле description, скомпилированное в документацию. Свертываемая панель Документация справа на странице обозревателя позволяет просматривать документацию по системе типов. Документы обновляются автоматически и будут удалять поля, которые являются устарел.

Боковая панель Docs содержит то же содержимое, которое автоматически создается из схемы в разделеДокументация по API GraphQL GitHub, хотя оно отформатировано по-разному в местах.

Использование панели переменных

Некоторые примеры вызовов включают переменные, написанные так:

query($number_of_repos:Int!){
  viewer {
    name
     repositories(last: $number_of_repos) {
       nodes {
         name
       }
     }
   }
}
variables {
   "number_of_repos": 3
}

Это правильный формат для отправки вызова с помощью POST запроса в curl команде (если вы экранируете новые строки).

Если вы хотите выполнить вызов в обозревателе, введите сегмент query на главной панели и переменные на панели Переменные запроса под ним. Опустите слово variables из обозревателя:

{
   "number_of_repos": 3
}

Использование интегрированной среды разработки клиента GraphQL Для Аналитики

Существует множество открытый код идентификаторов клиента GraphQL. Например, вы можете использовать «Алтайкер» для доступа к api GraphQL GitHub. Чтобы получить доступ к API GraphQL с помощью «Алтайкера», скачайте и установите его из алтаймер-графла или алтайкера. Затем выполните приведенные ниже действия по настройке.

Настройка Алтаймера

Получение маркера доступа.
Запустите Алтайкера.
В левой боковой панели под логотипом «Алтаймер» нажмите кнопку «Задать заголовки». Открывается новое окно.
В поле "Ключ заголовка" введите Authorization.
В поле "Значение заголовка" введите Bearer TOKEN, заменив TOKEN маркер с первого шага.
Нажмите кнопку "Сохранить " в правом нижнем углу окна, чтобы сохранить заголовок авторизации.
В поле "Конечная точка GraphQL" введите URL-адрес GraphQL, например http(s)://HOSTNAME/api/graphql.
Чтобы загрузить схему GraphQL GitHub, скачайте общедоступную схему.
В Алтаймере щелкните документы в правом верхнем углу, а затем три точки и схему загрузки...
Выберите общедоступную схему файла, которую вы скачали на предыдущем шаге.

Note

Дополнительные сведения о том, почему POST это метод, см. в разделе "Формирование вызовов с помощью GraphQL".

Можно проверить доступ, сделав запрос себе:

query {
  viewer {
    login
  }
}

Если все сработало правильно, будет отображаться ваше имя для входа. Все готово для начала выполнения запросов.

Запрос поддержки

Для вопросов, отчетов об ошибках и обсуждениях о GitHub Apps, OAuth appsи разработке API, изучите Категория API и веб-перехватчиков в обсуждениях сообщества GitHub. Обсуждения модерируются и поддерживаются сотрудниками GitHub и отвечают сообществу GitHub.

В службу поддержки GitHub можно обратиться напрямую через форму связи, чтобы получить:

гарантированный ответ от сотрудников GitHub Enterprise Server;
запросы на поддержку, связанные с конфиденциальными данными или частными проблемами;
запросы функций;
отзывы о продуктах GitHub Enterprise Server.

Устранение ошибок

Так как GraphQL является интроспективным, обозреватель поддерживает:

Интеллектуальные опережающие вводы с учетом текущей схемы
Предварительный просмотр ошибок проверки при вводе

Если вы вводите запрос с неправильным форматом или запрос, который не проходит проверку схемы, всплывающее окно предупредит вас об ошибке. При выполнении запроса ошибка возвращается в панель ответов.

Ответ GraphQL содержит несколько ключей: хэш data и массив errors.

{
  "data": null,
  "errors": [
    {
      "message": "Objects must have selections (field 'nodes' returns Repository but has no selections)",
      "locations": [
        {
          "line": 5,
          "column": 8
        }
      ]
    }
  ]
}

Возможно, вы столкнулись с непредвиденной ошибкой, не связанной со схемой. В этом случае сообщение будет содержать справочный код, который можно использовать, сообщая о проблеме:

{
  "data": null,
  "errors": [
    {
      "message": "Something went wrong while executing your query. This is most likely a GitHub bug. Please include \"7571:3FF6:552G94B:69F45B7:5913BBEQ\" when reporting this issue."
    }
  ]
}