REST API 시작

GitHub REST API, http(s)://HOSTNAME/api/v3의 기준 URL을 전체 URL을 가져오는 경로 앞에 추가합니다 http(s)://HOSTNAME/api/v3/octocat. [hostname]을 GitHub Enterprise Server 인스턴스의 이름으로 바꿉니다.

명령줄에서 curl 명령을 사용합니다. --request 또는 -X 플래그를 사용하고 그 뒤에는 HTTP 메서드가 따라옵니다. --url 플래그를 사용하고 그 뒤에는 전체 URL이 따라옵니다.

curl --request GET \
--url "https://api.github.com/octocat"

curl 명령에서 토큰을 사용하여 Authorization 머리글을 보냅니다. YOUR-TOKEN을 실제 토큰으로 바꿉니다.

curl --request GET \
--url "https://api.github.com/octocat" \
--header "Authorization: Bearer YOUR-TOKEN"

또한 run 키워드를 사용하여GitHub Actions 워크플로에서 curl 명령을 실행할 수도 있습니다. 자세한 내용은 "GitHub Actions에 대한 워크플로 구문"을 참조하세요.

GitHub에서는 토큰을 만드는 대신 기본 제공 GITHUB_TOKEN을 사용하여 인증하는 것이 좋습니다. 가능하지 않은 경우 토큰을 비밀로 저장하고 아래 예제의 GITHUB_TOKEN을 비밀의 이름으로 바꿉니다. GITHUB_TOKEN에 대한 자세한 정보는 "자동 토큰 인증"을(를) 참조하세요. 비밀에 대한 자세한 정보는 "GitHub Actions에서 비밀 사용"을(를) 참조하세요.

jobs:
  use_api:
    runs-on: ubuntu-latest
    permissions: {}
    steps:
      - env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          curl --request GET \
          --url "https://api.github.com/octocat" \
          --header "Authorization: Bearer $GH_TOKEN"

curl 명령에서 머리글을 보내려면 key: value 형식으로 뒤에 헤더가 따라오는 --header 또는 -H 플래그를 사용합니다.

curl --request GET \
--url "https://api.github.com/octocat" \
--header "Accept: application/vnd.github+json" \
--header "Authorization: Bearer YOUR-TOKEN"

octocat/Spoon-Knife 리포지토리에서 이슈를 가져오려면 octocat으로 {owner}를, Spoon-Knife로 {repo}를 바꿉니다. 전체 경로를 빌드하려면 GitHub REST API인 https://api.github.com(https://api.github.com/repos/octocat/Spoon-Knife/issues)에 대한 기준 URL 앞에 추가합니다.

curl --request GET \
--url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \
--header "Accept: application/vnd.github+json" \
--header "Authorization: Bearer YOUR-TOKEN"

curl 명령의 경우 경로 끝에 ?를 추가한 다음 쿼리 매개 변수 이름과 값을 parameter_name=value 양식으로 추가합니다. 쿼리 매개 변수가 여러 개이면 &로 구분합니다.

curl --request GET \
--url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2&sort=updated&direction=asc" \
--header "Accept: application/vnd.github+json" \
--header "Authorization: Bearer YOUR-TOKEN"

일부 작업은 배열인 쿼리 매개 변수를 사용합니다. 쿼리 문자열에서 배열을 보내려면 배열 항목당 쿼리 매개 변수를 한 번 사용하고 쿼리 매개 변수 이름 뒤에 []을(를) 추가 합니다. 예를 들어 두 리포지토리 ID의 배열을 제공하려면 ?repository_ids[]=REPOSITORY_A_ID&repository_ids[]=REPOSITORY_B_ID를 사용합니다.

curl 명령의 경우 --data 플래그를 사용하여 JSON 개체의 본문 매개 변수를 전달합니다.

curl --request POST \
--url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \
--header "Accept: application/vnd.github+json" \
--header "Authorization: Bearer YOUR-TOKEN" \
--data '{
  "title": "Created with the REST API",
  "body": "This is a test issue created by the REST API"
}'

상태 코드 및 헤더를 보려면 요청을 보낼 때 --include 또는 --i 플래그를 사용합니다.

예를 들어 이 요청은 다음과 같습니다.

curl --request GET \
--url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \
--header "Accept: application/vnd.github+json" \
--header "Authorization: Bearer YOUR-TOKEN" \
--include

다음과 같은 응답 코드 및 헤더를 반환합니다.

HTTP/2 200
server: GitHub.com
date: Thu, 04 Aug 2022 20:07:51 GMT
content-type: application/json; charset=utf-8
cache-control: public, max-age=60, s-maxage=60
vary: Accept, Accept-Encoding, Accept, X-Requested-With
etag: W/"7fceb7e8c958d3ec4d02524b042578dcc7b282192e6c939070f4a70390962e18"
x-github-media-type: github.v3; format=json
link: <https://api.github.com/repositories/1300192/issues?per_page=2&sort=updated&direction=asc&page=2>; rel="next", <https://api.github.com/repositories/1300192/issues?per_page=2&sort=updated&direction=asc&page=7409>; rel="last"
access-control-expose-headers: ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset
access-control-allow-origin: *
strict-transport-security: max-age=31536000; includeSubdomains; preload
x-frame-options: deny
x-content-type-options: nosniff
x-xss-protection: 0
referrer-policy: origin-when-cross-origin, strict-origin-when-cross-origin
content-security-policy: default-src 'none'
x-ratelimit-limit: 15000
x-ratelimit-remaining: 14996
x-ratelimit-reset: 1659645535
x-ratelimit-resource: core
x-ratelimit-used: 4
accept-ranges: bytes
content-length: 4936
x-github-request-id: 14E0:4BC6:F1B8BA:208E317:62EC2715

이 예제에서 응답 코드는 성공적인 요청을 나타내는 200입니다.

curl --request GET \
--url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \
--header "Accept: application/vnd.github+json" \
--header "Authorization: Bearer YOUR-TOKEN"

예를 들어 >는 응답을 파일로 리디렉션하는 데 사용할 수 있습니다.

curl --request GET \
--url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \
--header "Accept: application/vnd.github+json" \
--header "Authorization: Bearer YOUR-TOKEN" > data.json

그런 다음 jq를 사용하여 각 이슈의 제목 및 작성자 ID를 가져올 수 있습니다.

jq '.[] | {title: .title, authorID: .user.id}' data.json

이전 두 명령은 다음과 같이 반환합니다.

{
  "title": "Update index.html",
  "authorID": 10701255
}
{
  "title": "Edit index file",
  "authorID": 53709285
}

jq에 대한 자세한 정보는 jq 설명서를 참조하세요.