Repolode
Enviar
octokit

octokit/octokit.js

SDK integral de GitHub para navegadores, Node.js y Deno, con clientes REST, GraphQL, GitHub App, webhooks y OAuth en un solo paquete.

Ver en GitHub
Estrellas
7,874
Forks
1,287
Issues abiertos
55
Último commit
hace 10 días

¿Qué es?

octokit.js es el paquete `octokit`, que reúne las principales bibliotecas de Octokit para llamar a las API de la plataforma de GitHub desde JavaScript y TypeScript. El cliente de API envía solicitudes REST (mediante los métodos `octokit.rest.*` o `octokit.request`) y consultas GraphQL, con autenticación, reintentos y control de límites de tasa integrados.

El paquete también incluye un cliente para GitHub Apps, tokens de instalación, gestión y verificación de webhooks, y flujos de inicio de sesión con OAuth. El helper `createNodeMiddleware` ofrece rutas listas para recibir webhooks y gestionar redirecciones de OAuth en el servidor http de Node o en Express. La entrada del cliente para Actions figura como pendiente.

El SDK funciona en navegadores modernos, Node.js (versión 18 o superior para usar fetch nativo) y Deno, e incluye declaraciones de TypeScript. También es posible instalar sus módulos por separado si solo se necesita parte de la funcionalidad.

Funciones clave

  • 01Llama a las API REST y GraphQL de GitHub mediante un único cliente.
  • 02Incluye estrategias de autenticación para tokens y GitHub Apps.
  • 03Gestiona los reintentos de solicitudes y el control de límites de tasa de forma predeterminada.
  • 04Ofrece helpers de paginación para resultados REST y GraphQL.
  • 05Recibe y verifica webhooks, y gestiona flujos de OAuth mediante un middleware de Node.
  • 06Incluye declaraciones de TypeScript y funciona en navegadores, Node.js y Deno.

Casos de uso

  • Crear un bot o una automatización que genere incidencias, comentarios o pull requests.
  • Desarrollar una GitHub App que reaccione a eventos de webhook en los repositorios donde está instalada.
  • Añadir el inicio de sesión con GitHub OAuth a una aplicación web.
  • Consultar datos de GitHub con GraphQL desde un frontend o un servicio de Node.js.

Inicio rápido

  1. 1

    Instala el paquete octokit con npm

    npm install octokit
  2. 2

    Importa Octokit y llama a la API de GitHub con un token de acceso personal

Antes de usarlo

  • Requiere Node 18 o superior, salvo que proporciones tu propia implementación de fetch.
  • Node.js no usa las variables de entorno estándar de proxy de forma predeterminada; se necesita un fetch personalizado con un agente proxy.
  • Para usarlo con las exports condicionales de Node, configura moduleResolution y module como node16 en tsconfig.json.

En colecciones

APIs GraphQL y clientes de APIInicio de sesión, SSO y servidores de identidad

Temas

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

Preguntas frecuentes

¿Qué es octokit.js?
SDK integral de GitHub para navegadores, Node.js y Deno, con clientes REST, GraphQL, GitHub App, webhooks y OAuth en un solo paquete. octokit.js es el paquete `octokit`, que reúne las principales bibliotecas de Octokit para llamar a las API de la plataforma de GitHub desde JavaScript y TypeScript. El cliente de API envía solicitudes REST (mediante los métodos `octokit.rest.*` o `octokit.request`) y consultas GraphQL, con autenticación, reintentos y control de límites de tasa integrados.
¿octokit.js es gratuito? ¿Qué licencia tiene?
octokit.js es open source bajo la licencia MIT. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿octokit.js sigue mantenido?
Mantenimiento activo. El último commit de octokit.js fue el 28 oct 2026.
¿Para qué puedo usar octokit.js?
Crear un bot o una automatización que genere incidencias, comentarios o pull requests. Desarrollar una GitHub App que reaccione a eventos de webhook en los repositorios donde está instalada. Añadir el inicio de sesión con GitHub OAuth a una aplicación web. Consultar datos de GitHub con GraphQL desde un frontend o un servicio de Node.js.
¿Cómo se instala octokit.js?
Instala el paquete octokit con npm: npm install octokit Importa Octokit y llama a la API de GitHub con un token de acceso personal
¿Dónde consigo octokit.js?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/octokit/octokit.js

Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.

Proyectos relacionados