Сведения API GraphQL

API GraphQL GitHub обеспечивает гибкость и возможность точно определить данные, которые необходимо получить.

В этой статье

Обзор

Ниже приведены быстрые ссылки, перейдя по которым, вы можете приступить к работе с API GraphQL:

Дополнительные сведения о API-интерфейсах %% данных variables.product.company_short %}см. в разделе "Сравнение REST API GitHub и API GraphQL".

Сведения о GraphQL

Язык запросов данных GraphQL:

  • Спецификация. Спецификация определяет допустимость схемы на сервере API. Схема определяет допустимость вызовов клиентов.

  • Строго типизированный. Схема определяет систему типов API и все отношения объектов.

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

  • Иерархический. Фигура вызова GraphQL отражает фигуру возвращаемых данных JSON. Вложенные поля позволяют запрашивать и получать только данные, указанные в одном круговом пути.

  • Слой приложения. GraphQL не является моделью хранилища или языком запросов к базе данных. Граф ссылается на структуры графов, определенные в схеме, где узлы определяют объекты, а края определяют отношения между объектами. API обходит и возвращает данные приложения на основе определений схемы, независимо от способа хранения данных.

Почему GitHub использует GraphQL

GitHub использует GraphQL, так как он предлагает значительно большую гибкость для наших интеграторов. Возможность точно определить нужные данные—и только данные, которые вам нужны—, является значительным преимуществом по сравнению с традиционными конечными точками REST API. GraphQL позволяет заменить несколько запросов REST с помощью одного вызова для получения указанных данных.

Дополнительные сведения о том, почему GitHub инвестирует в GraphQL, см. в исходной записи блога с объявлением.

Сведения о ссылке на схему GraphQL

Документы на боковой панели создаются на основе схемы GraphQL GitHub. Все вызовы проверяются и выполняются согласно схеме. Используйте эти документы, чтобы узнать, какие данные можно вызвать:

Доступ к этому содержимому можно получить на боковой панели документации обозревателя. Обратите внимание, что для успешного вызова API GraphQL может потребоваться использовать как документы, так и проверку схемы.

Другие сведения, например о проверке подлинности и ограничении скорости, см. в руководствах.

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

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

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

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

При возникновении непредвиденных сбоев можно использовать githubstatus.com или API состояния GitHub для проверки инцидентов, влияющих на API.