Repolode
Предложить
octokit

octokit/octokit.js

Универсальный GitHub SDK для браузеров, Node.js и Deno: REST, GraphQL, GitHub App, вебхуки и OAuth в одном пакете.

Открыть на GitHub
Звёзды
7,874
Форки
1,287
Открытые issues
55
Последний коммит
9 дней назад

Что это?

octokit.js — это пакет `octokit`, объединяющий основные библиотеки Octokit для работы с API платформы GitHub из JavaScript и TypeScript. Клиент API отправляет REST-запросы (через методы `octokit.rest.*` или `octokit.request`) и GraphQL-запросы; в него встроены аутентификация, повторные попытки и ограничение частоты запросов.

В пакет также входят клиент для GitHub Apps, работа с токенами установок, обработка и проверка вебхуков, а также сценарии входа через OAuth. Вспомогательная функция `createNodeMiddleware` предоставляет готовые маршруты для получения вебхуков и обработки перенаправлений OAuth в HTTP-сервере Node.js или Express. Клиент для GitHub Actions пока не готов.

SDK работает в современных браузерах, Node.js (версии 18 и выше для встроенного fetch) и Deno и поставляется с объявлениями TypeScript. При необходимости можно установить модули отдельно и использовать только часть возможностей.

Ключевые возможности

  • 01Позволяет обращаться к REST API и GraphQL API GitHub через один клиент.
  • 02Включает стратегии аутентификации с токенами и для GitHub Apps.
  • 03По умолчанию повторяет запросы при ошибках и ограничивает частоту запросов.
  • 04Предоставляет вспомогательные средства для постраничного получения результатов REST и GraphQL.
  • 05Принимает и проверяет вебхуки, а также обрабатывает сценарии OAuth с помощью middleware для Node.js.
  • 06Поставляется с объявлениями TypeScript и работает в браузерах, Node.js и Deno.

Сценарии использования

  • Создание бота или автоматизации для работы с задачами, комментариями и pull request.
  • Разработка GitHub App, реагирующего на события вебхуков в установленных репозиториях.
  • Добавление входа через GitHub OAuth в веб-приложение.
  • Запрос данных GitHub с помощью GraphQL из frontend-приложения или сервиса на Node.js.

Быстрый старт

  1. 1

    Установите пакет octokit с помощью npm

    npm install octokit
  2. 2

    Импортируйте Octokit и вызывайте GitHub API с персональным токеном доступа

Что важно знать

  • Требуется Node 18 или выше, если вы не предоставите собственную реализацию fetch.
  • Node.js по умолчанию не использует стандартные переменные окружения прокси; необходима пользовательская реализация fetch с прокси-агентом.
  • Для использования с условными exports в Node задайте moduleResolution и module равными node16 в tsconfig.json.

В подборках

GraphQL API и клиенты для APIВход, SSO и серверы идентификации

Темы

#github#sdk#api-client#typescript#webhooks#oauth#graphql#rest-api#hacktoberfest#javascript

Частые вопросы

Что такое octokit.js?
Универсальный GitHub SDK для браузеров, Node.js и Deno: REST, GraphQL, GitHub App, вебхуки и OAuth в одном пакете. octokit.js — это пакет `octokit`, объединяющий основные библиотеки Octokit для работы с API платформы GitHub из JavaScript и TypeScript. Клиент API отправляет REST-запросы (через методы `octokit.rest.*` или `octokit.request`) и GraphQL-запросы; в него встроены аутентификация, повторные попытки и ограничение частоты запросов.
octokit.js можно использовать бесплатно? Какая у него лицензия?
octokit.js распространяется с открытым исходным кодом под лицензией MIT. Перед использованием в коммерческих продуктах проверьте условия лицензии.
octokit.js всё ещё поддерживается?
Активно поддерживается. Последний коммит в octokit.js — 28 окт. 2026 г..
Для чего можно использовать octokit.js?
Создание бота или автоматизации для работы с задачами, комментариями и pull request. Разработка GitHub App, реагирующего на события вебхуков в установленных репозиториях. Добавление входа через GitHub OAuth в веб-приложение. Запрос данных GitHub с помощью GraphQL из frontend-приложения или сервиса на Node.js.
Как установить octokit.js?
Установите пакет octokit с помощью npm: npm install octokit Импортируйте Octokit и вызывайте GitHub API с персональным токеном доступа
Где скачать octokit.js?
Исходный код и инструкции по установке — на GitHub: https://github.com/octokit/octokit.js

Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.

Похожие проекты

NangoHQ / nango

Open-source платформа для создания и запуска интеграций с более чем 1 000 API: OAuth, обновление токенов и API-запросы.

Бэкенд и API#integrations#oauth#api
13,1 тыс.+85 за неделю1,5 тыс.TypeScriptOtherОбновлён 5 часов назад