Сведения о REST API

Ознакомьтесь с документацией по REST API.

В этой статье

Api %% данных variables.product.company_short %}можно использовать для создания скриптов и приложений, которые автоматизируют процессы, интегрируются с GitHub, а также расширяют GitHub. Например, api можно использовать для обработки проблем, создания панели мониторинга аналитики или управления выпусками.

Каждая конечная точка REST API задокументирована по отдельности, а конечные точки классифицируются по ресурсу, который они влияют в первую очередь. Например, можно найти конечные точки, связанные с проблемами в Конечные точки REST API для проблем.

Начало работы с REST API

          **Если вы не знакомы с REST API**, вы можете найти полезные сведения о кратком руководстве или руководстве по началу работы. Дополнительные сведения см. в разделе:

* Быстрый старт для GitHub REST API * Начало работы с REST API

          **Если вы знакомы с REST API** , но новые для GitHubREST API, возможно, полезно ознакомиться с документацией по проверке подлинности. Дополнительные сведения см. в разделе:

* Проверка подлинности в REST API

          **Если вы создаете скрипты или приложения** , использующие REST API, вы можете найти некоторые из следующих руководств. Примеры сценариев с помощью REST API см. в следующих примерах:

* Скриптирование с помощью REST API и JavaScript * Скриптирование с помощью REST API и Ruby * Создание приложения GitHub, которое реагирует на события webhook * Создание CLI с помощью приложения GitHub * Автоматическое повторение неудачных поставок для веб-перехватчика репозитория

Список библиотек для упрощения сценариев с помощью REST API см. в разделе Библиотеки для REST API.

Если вы создаете скрипты или приложения, использующие REST API, вам также может потребоваться использовать веб-перехватчики для получения уведомлений о событиях или GitHub App для доступа к ресурсам от имени пользователя или организации. Дополнительные сведения см. в разделе [AUTOTITLE и Сведения о веб-перехватчиках](/apps/creating-github-apps/about-creating-github-apps/deciding-when-to-build-a-github-app).

Дополнительные материалы

  •         [AUTOTITLE](/rest/overview/comparing-githubs-rest-api-and-graphql-api)

  •         [AUTOTITLE](/rest/guides/best-practices-for-using-the-rest-api)

  •         [AUTOTITLE](/rest/overview/keeping-your-api-credentials-secure)

  •         [AUTOTITLE](/rest/overview/troubleshooting-the-rest-api)