[GitHub]GitHub API 사용하는 법

🌌 GitHub API 활용하기

GitHub User 받아오기

GitHub 사용자를 받아오기 위해 GitHub API 활용하려고 해요. Entity를 구현하기 위해서는 데이터가 어떤 형태로 넘어오는지 확인해야 하기 때문에 공식문서를 확인해요.

공식 문서: https://docs.github.com/en/rest/reference/search#search-users

 

공식 문서의 일부를 가져올게요.

우선 GitHub API이므로 base URL은 "https://api.github.com" 일거에요. 여기에 endpoint로 /search/users가 붙겠네요.

즉, 기본 URL 형태는 "https://api.github.com/search/users"가 돼요.

여기에서 중요한 것이 Parameter에요.

 

이 부분을 이해하기 위해서는 GET 방식의 통신과 URL query를 이해할 필요가 있어요. 원하는 검색 결과를 얻기 위해 검색 조건을 보통의 메서드처럼 parameter에 넣을 것이고, URL에서는 "?"를 통해 구분지어요. 이해하기 어렵기 때문에 아래의 예시로 이어가 볼게요.

 

위의 공식문서 예시를 해석해보면, 이름이 tom인 사용자를 찾아요. 그리고 repository가 42개 이상, 팔로워가 1000명 이상인 사용자를 찾는 거죠.

헷갈릴 수 있기 때문에 우선 이름으로 설명해볼게요 :] 

 

만약, 보통의 코딩 언어에서 원하는 조건을 넣어 검색을 한다면 어떤 형태일까요?

검색할 이름을 넣는다 -> 원하는 결과물을 얻는다

 

이기 때문에 아래와 같은 형태일 거예요(Java로 작성).

String[] gitHubUsers = ["...", "...", "..."]

public foo searchGitHubUser(String userName) {
    // gitHubUsers에서 userName을 가진 목록을 검색하는 로직
    return bar
}

 

API에 요청할 때에도 같은 원리예요! 저 유저 이름을 쿼리에 담아 보내는 것이고, GitHub API는 그걸 q라고 정의해뒀어요. 

그래서 tom이라는 이름을 검색하려고 q=tom이 되는 거죠.

이걸 합쳐보면 "tom이라는 이름의 GitHub User를 알려줘"라는 주소는

https://api.github.com/search/users?q="tom"

 

이 되는 것이죠.

 

확인을 위해서 Postman을 활용해볼게요! 

Postman

기본 URL을 작성한 후 Query Params 쿼리 인자에 q를 key로 하고 값을 tom으로 넣어주면 자동으로 URL이 완성돼요.

그리고 요청을 Send로 보내면

 

200 OK에 정상적으로 결과값을 받아오는 걸 확인할 수 있죠. 

JSON 형태로 넘어오네요 :]

 

공식 문서에 Response 형태도 친절하게 나와있어요.

 

클라이언트 개발자의 경우 통신을 구현할 때 이렇게 GitHub API로 통신 가능을 확인하고, 추후 원하는 endpoint로 변경할 수 있을 것 같아요. 

 

혹시 잘못되거나 추가할 정보가 있다면 댓글 환영합니다 :]