GitHub API 사용해보기

간단한 GitHub Finder 라는 페이지의 검색 기능을 GitHub의 검색기능을 통해 실제데이터를 가져오려고 합니다. 그러기 위해 GitHub의 REST API를 사용해야만 했으며, 사용하면서 사용방법에 대해 정리해보고자 합니다.

그럼, 우선 GitHub의 REST API를 javascript 에서 사용하기 위해서는 사전작업이 필요하기에 공식 페이지를 확인해보았습니다.

https://docs.github.com/ko/rest/quickstart?apiVersion=2022-11-28

Octokit.js 사용

---

액세스 토큰 만들기

Octokit.js 사용하기 위해 personal access token 또는 GitHub App 사용자 액세스 토큰을 만듭니다.

여기서 세밀한 개인 액세스 토큰과 개인 액세스 토큰(클래식) 두 종류가 있지만, 세밀한 토큰은 베타 버전이기도 하고 일부 기능은 클래식 토큰에서만 작동하기에 클래식 토큰으로 발급을 진행했습니다.

개인 액세스 토큰 ( 클래식 ) 발급

https://docs.github.com/ko/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic

위의 가이드 대로 진행하다보면 이처럼 정상적으로 토큰이 발급됩니다.

개인 액세스 토큰 코드 보안 추가

https://docs.github.com/en/codespaces/managing-your-codespaces/managing-secrets-for-your-codespaces

개인 액세스 토큰을 보여주지 않기 위해 코드스페이스에 secret 코드를 추가했습니다.

Search users

https://docs.github.com/ko/rest/search/search?apiVersion=2022-11-28#search-users

// Octokit.js
// https://github.com/octokit/core.js#readme
const octokit = new Octokit({
  auth: 'YOUR-TOKEN'
})

const response = await octokit.request('GET /search/users', {
  headers: {
    'X-GitHub-Api-Version': '2022-11-28'
  },
  q: "검색할 id"
})

console.log(response);

결과

이렇게 유저를 검색할 수 있었으며, 검색된 유저의 상세 정보를 다른 api 주소를 통해 더욱 자세히 확인할 수 있었습니다.