octokit/octokit.js

어떤 프로젝트인가요?

핵심 기능

• 01하나의 클라이언트로 GitHub REST 및 GraphQL API를 호출합니다.
• 02토큰과 GitHub Apps용 인증 전략을 포함합니다.
• 03요청 재시도와 rate limit에 따른 요청 조절을 기본으로 처리합니다.
• 04REST 및 GraphQL 결과를 위한 페이지네이션 헬퍼를 제공합니다.
• 05Node 미들웨어를 통해 webhook을 받고 검증하며 OAuth 흐름을 처리합니다.
• 06TypeScript 선언 파일을 제공하며 브라우저, Node.js, Deno에서 실행됩니다.

활용 사례

• 이슈, 댓글 또는 pull request를 생성하는 봇이나 자동화 도구를 만들 때.
• 설치된 저장소의 webhook 이벤트에 반응하는 GitHub App을 작성할 때.
• 웹 애플리케이션에 GitHub OAuth 로그인을 추가할 때.
• 프런트엔드나 Node.js 서비스에서 GraphQL로 GitHub 데이터를 조회할 때.

빠른 시작

1. 1

   npm으로 octokit 패키지를 설치합니다

   npm install octokit
2. 2

   Octokit을 가져오고 개인 액세스 토큰으로 GitHub API를 호출합니다

사용 전 알아둘 점

• !직접 fetch 구현을 제공하지 않는 한 Node 18 이상이 필요합니다.
• !Node.js는 기본적으로 표준 프록시 환경 변수를 사용하지 않으므로 프록시 에이전트를 사용하는 사용자 지정 fetch가 필요합니다.
• !Node의 조건부 exports와 함께 사용하려면 tsconfig.json에서 moduleResolution과 module을 node16으로 설정해야 합니다.

포함된 컬렉션

토픽

자주 묻는 질문

octokit.js은(는) 무엇인가요?

REST, GraphQL, GitHub App, webhook, OAuth 클라이언트를 하나로 묶어 브라우저, Node.js, Deno에서 사용할 수 있는 올인원 GitHub SDK입니다. octokit.js는 JavaScript와 TypeScript에서 GitHub 플랫폼 API를 호출하는 데 쓰이는 주요 Octokit 라이브러리를 묶은 `octokit` 패키지입니다. API 클라이언트는 `octokit.rest.*` 메서드나 `octokit.request`를 통해 REST 요청을 보내고 GraphQL 쿼리를 실행하며, 인증, 재시도, rate limit에 따른 요청 조절 기능을 기본으로 제공합니다.

octokit.js은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?

octokit.js은(는) MIT 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.

octokit.js은(는) 아직 유지보수되고 있나요?

활발히 유지보수 중. octokit.js의 마지막 커밋은 2026년 10월 28일입니다.

octokit.js은(는) 어디에 사용할 수 있나요?

이슈, 댓글 또는 pull request를 생성하는 봇이나 자동화 도구를 만들 때. 설치된 저장소의 webhook 이벤트에 반응하는 GitHub App을 작성할 때. 웹 애플리케이션에 GitHub OAuth 로그인을 추가할 때. 프런트엔드나 Node.js 서비스에서 GraphQL로 GitHub 데이터를 조회할 때.

octokit.js는 어떻게 설치하나요?

npm으로 octokit 패키지를 설치합니다: npm install octokit Octokit을 가져오고 개인 액세스 토큰으로 GitHub API를 호출합니다

octokit.js은(는) 어디서 받을 수 있나요?

소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/octokit/octokit.js