Использование клиентов GraphQL

Использование идентификаторов клиента GraphQL

Существует множество клиентских идентификаторов GraphQL с открытым кодом, которые можно использовать для доступа к API GraphQL GitHub.

Дополнительные сведения о методах HTTP, проверке подлинности и структуре вызовов GraphQL см. в Формирование вызовов с помощью GraphQL .

Сначала выберите клиента. Распространенные варианты: GraphiQL, Бессонница и Алтайкер (desktop/web/extension). Полный список клиентов можно просмотреть в каталоге инструментов организации GraphQL.

Следующие универсальные инструкции будут работать с большинством клиентов GraphQL:

1. Наведите указатель клиента на конечную точку GraphQL: http(s)://HOSTNAME/api/graphql

2. Добавьте заголовок: Authorization (замените Authorization: Bearer TOKEN``TOKEN данные GitHub personal access token. Дополнительные сведения см. в разделе Управление личными маркерами доступа.

3. Задайте для метода POST запроса значение или если оно доступно, используйте режим GraphQL, предоставленный клиентом.

4. Введите запрос или мутацию в редакторе, а при необходимости укажите переменные на панели "Переменные".

   Пример:

   query {
     viewer {
       login
     }
   }
   

5. Если клиенту нужна схема для отрисовки документации или автозаполнения, получите ее с помощью запроса introspection GraphQL. Многие клиенты могут выполнять это автоматически с панели "Документация".

   Минимальный запрос интроспекции:

   query IntrospectionQuery {
     __schema {
       types {
         name
       }
     }
   }
   

6. Запустите запрос и проверьте ответ JSON. Запрос из примера должен возвращать имя входа, связанное с данными GitHub personal access token с проверкой подлинности.

Используйте пользовательский интерфейс клиента для изучения документов, выполнения запросов и сохранения запросов по мере необходимости.

GitHub CLI

Можно также использовать командную строку с GitHub CLI для выполнения запросов GraphQL.

1. Установка и проверка подлинности с помощью GitHub CLI.
2. Запустите запрос к http(s)://HOSTNAME/api/graphql использованию конечной точки GraphQL с gh api подкоманда.

Пример:

gh api graphql -f query='query { viewer { login } }'

Это должно вернуть имя входа, связанное с данными GitHub personal access token с проверкой подлинности.

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

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

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

• Гарантированный ответ от персонала GitHub
• Запросы на поддержку, связанные с конфиденциальными данными или частными проблемами
• Запросы функций
• Отзывы о продуктах GitHub