Repolode
Enviar
octokit

octokit/octokit.js

O SDK completo do GitHub para browsers, Node.js e Deno, que reúne clientes REST, GraphQL, GitHub App, webhooks e OAuth em um único pacote.

Ver no GitHub
Estrelas
7,874
Forks
1,287
Issues abertas
55
Último commit
há 9 dias

O que é?

octokit.js é o pacote `octokit`, que reúne as principais bibliotecas Octokit para acessar as APIs da plataforma GitHub com JavaScript e TypeScript. O cliente de API envia requisições REST (por meio dos métodos `octokit.rest.*` ou de `octokit.request`) e consultas GraphQL, com autenticação, novas tentativas e controle de limite de requisições integrados.

O pacote também inclui um cliente para GitHub Apps, tokens de instalação, tratamento e verificação de webhooks e fluxos de login OAuth. O helper `createNodeMiddleware` oferece rotas prontas para receber webhooks e tratar redirecionamentos OAuth no servidor http do Node ou no Express. A entrada do cliente para Actions aparece como pendente.

O SDK funciona em browsers modernos, Node.js (versão 18 ou superior para usar o fetch nativo) e Deno, e inclui declarações TypeScript. Também é possível instalar os módulos separadamente para usar apenas parte das funcionalidades.

Recursos principais

  • 01Acessa as APIs REST e GraphQL do GitHub por meio de um único cliente.
  • 02Inclui estratégias de autenticação para tokens e GitHub Apps.
  • 03Gerencia novas tentativas de requisições e o controle de limite de requisições por padrão.
  • 04Oferece helpers de paginação para resultados REST e GraphQL.
  • 05Recebe e verifica webhooks e gerencia fluxos OAuth por meio de um middleware para Node.
  • 06Inclui declarações TypeScript e funciona em browsers, Node.js e Deno.

Casos de uso

  • Criar um bot ou uma automação que abra issues, comentários ou pull requests.
  • Desenvolver um GitHub App que reaja a eventos de webhook em repositórios nos quais está instalado.
  • Adicionar login com GitHub OAuth a uma aplicação web.
  • Consultar dados do GitHub com GraphQL em um frontend ou serviço Node.js.

Início rápido

  1. 1

    Instale o pacote octokit com npm

    npm install octokit
  2. 2

    Importe Octokit e chame a API do GitHub com um token de acesso pessoal

Antes de usar

  • Requer Node 18 ou superior, a menos que você forneça sua própria implementação de fetch.
  • O Node.js não usa variáveis de ambiente padrão de proxy por padrão; é necessário um fetch personalizado com um agente de proxy.
  • Para usar com os exports condicionais do Node, defina moduleResolution e module como node16 no tsconfig.json.

Em coleções

APIs GraphQL e clientes de APILogin, SSO e servidores de identidade

Tópicos

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

Perguntas frequentes

O que é octokit.js?
O SDK completo do GitHub para browsers, Node.js e Deno, que reúne clientes REST, GraphQL, GitHub App, webhooks e OAuth em um único pacote. octokit.js é o pacote `octokit`, que reúne as principais bibliotecas Octokit para acessar as APIs da plataforma GitHub com JavaScript e TypeScript. O cliente de API envia requisições REST (por meio dos métodos `octokit.rest.*` ou de `octokit.request`) e consultas GraphQL, com autenticação, novas tentativas e controle de limite de requisições integrados.
octokit.js é gratuito? Qual é a licença?
octokit.js é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
octokit.js ainda é mantido?
Manutenção ativa. O último commit de octokit.js foi em 28 de out. de 2026.
Para que posso usar octokit.js?
Criar um bot ou uma automação que abra issues, comentários ou pull requests. Desenvolver um GitHub App que reaja a eventos de webhook em repositórios nos quais está instalado. Adicionar login com GitHub OAuth a uma aplicação web. Consultar dados do GitHub com GraphQL em um frontend ou serviço Node.js.
Como instalar octokit.js?
Instale o pacote octokit com npm: npm install octokit Importe Octokit e chame a API do GitHub com um token de acesso pessoal
Onde consigo octokit.js?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/octokit/octokit.js

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados