1
0
mirror of synced 2026-01-06 06:02:35 -05:00
Files
docs/translations/ru-RU/content/graphql/guides/using-the-explorer.md
2022-11-16 21:42:42 +00:00

7.6 KiB
Raw Blame History

title, intro, redirect_from, versions, topics, ms.openlocfilehash, ms.sourcegitcommit, ms.translationtype, ms.contentlocale, ms.lasthandoff, ms.locfileid
title intro redirect_from versions topics ms.openlocfilehash ms.sourcegitcommit ms.translationtype ms.contentlocale ms.lasthandoff ms.locfileid
Использование обозревателя Вы можете выполнять запросы к реальным данным {% data variables.product.prodname_dotcom %} с помощью обозревателя GraphQL, интегрированной среды разработки в браузере, которая включает документы, выделение синтаксиса и ошибки проверки.
/v4/guides/using-the-explorer
fpt ghec ghes ghae
* * * *
API
19c534dd0cdcacdfd0d96bb93d055ff3fca8690b 47bd0e48c7 HT ru-RU 09/05/2022 146749492

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

{% ifversion fpt or ghec %}

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

{% else %}

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

{% endif %}

Использование GraphiQL

Чтобы использовать приложение GraphiQL, скачайте и установите его с https://github.com/skevy/graphiql-app.

Настройка GraphiQL

  1. Получение токена OAuth.
  2. Запустите GraphiQL.
  3. В правом верхнем углу GraphiQL щелкните Edit HTTP Headers (Изменить заголовки HTTP).
  4. В поле Ключ введите Authorization. В поле Значение введите Bearer <token>, где <token> — это созданный токен OAuth. Заголовки graphiql
  5. Установите флажок справа от токена, чтобы его сохранить.
  6. Чтобы вернуться в редактор, щелкните за пределами модального окна Изменить заголовки HTTP.
  7. В поле GraphQL Endpoint (Конечная точка GraphQL) введите {% data variables.product.graphql_url_pre %}.
  8. В раскрывающемся меню Метод выберите POST.

{% note %}

Примечание. Дополнительные сведения о том, почему POST является методом, см. в разделе Взаимодействие с GraphQL.

{% endnote %}

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

query {
  viewer {
    login
  }
}

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

Доступ к документации на боковой панели

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

{% note %}

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

{% endnote %}

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

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

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

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

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

{
   "number_of_repos": 3
}

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

{% data reusables.support.help_resources %}

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

Так как 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."
    }
  ]
}

{% note %}

Примечание. {% data variables.product.prodname_dotcom %} рекомендует проверять наличие ошибок перед использованием данных в рабочей среде. В GraphQL сбой не является общим: часть запросов GraphQL может быть выполнена успешно, а другая — завершиться сбоем.

{% endnote %}