[Java] Github API 사용법

• 이 글은 "온라인 자바 스터디 내용"을 정리한 글입니다.

Github Token 발급

• Github API를 사용하기 위해서는 Github 페이지를 가서 Personal access token을 발급받아야 합니다.
• Github에서 프로필을 클릭 후 Setting -> Developer setting -> Personal access tokens 순으로 클릭합니다.
• 밑에 그림에서 token을 사용하는 scope를 설정합니다. 저는 issues의 comment를 확인할 것이기 때문에 repo만 클릭하면 됩니다.

Postman 다운로드

• https://www.postman.com/downloads/ 공식 홈페이지에 들어가서 Postman을 다운로드 받습니다.
• Postman은 개발한 API를 테스트하고, 테스트 결과를 공유하여 API 개발의 생산성을 높여주는 플랫폼입니다.
• Github API를 바로 사용하는 방법보다는 postman을 통해 테스트를 하여 원하는 데이터를 얻기 위해서는 어떤 순서대로 탐색해야 하는지 확인합니다.
• Github api repository get : https://api.github.com/repos/user/repo
• 참조(https://docs.github.com/en/free-pro-team@latest/rest/guides/getting-started-with-the-rest-api)

Github API 사용

다음 코드를 Gradle에 추가해야 합니다.

compile 'org.kohsuke:github-api:1.119'

• 이후 두 개의 Docs를 참고하여 코드를 구현하였습니다.
• https://github-api.kohsuke.org/dependency-info.html
• https://github-api.kohsuke.org/apidocs/org/kohsuke/github/package-summary.html

저는 Github의 특정 Repo의 comment를 남긴 사용자의 횟수를 통해 몇% 참여했는지 파악하는 과제를 하였습니다.
(https://github.com/whiteship/live-study/issues/4)

• 추가로 궁금한 점이나 수정할 부분 있으면 댓글로 남겨주세요.