Skip to main content
설명서에 자주 업데이트를 게시하며 이 페이지의 번역이 계속 진행 중일 수 있습니다. 최신 정보는 영어 설명서를 참조하세요.

Gist 설명

REST API를 사용하여 gist에 대한 주석을 보고 수정합니다.

gist 주석 정보

REST API를 사용하여 gist에 대한 주석을 보고 수정할 수 있습니다. gists에 대한 자세한 내용은 "Gist가 있는 콘텐츠의 편집 및 공유.

Gist 설명에 대한 사용자 지정 미디어 유형

다음은 gist 설명에 지원되는 미디어 유형입니다.

application/vnd.github.VERSION.raw
application/vnd.github.VERSION.base64

미디어 유형에 대한 자세한 내용은 "미디어 유형"을 참조하세요.

List gist comments

"List gist comments"에 대한 매개 변수

헤더
Name, 형식, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
Name, 형식, 설명
gist_id string 필수

The unique identifier of the gist.

쿼리 매개 변수
Name, 형식, 설명
per_page integer

The number of results per page (max 100).

기본값: 30

page integer

Page number of the results to fetch.

기본값: 1

"List gist comments"에 대한 HTTP 응답 상태 코드

상태 코드Description
200

OK

304

Not modified

403

Forbidden

404

Resource not found

"List gist comments"에 대한 코드 샘플

get/gists/{gist_id}/comments
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/gists/GIST_ID/comments

Response

Status: 200
[ { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", "url": "https://HOSTNAME/gists/a6db0bec360bb87e9418/comments/1", "body": "Just commenting for the sake of commenting", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://HOSTNAME/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://HOSTNAME/users/octocat/followers", "following_url": "https://HOSTNAME/users/octocat/following{/other_user}", "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}", "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions", "organizations_url": "https://HOSTNAME/users/octocat/orgs", "repos_url": "https://HOSTNAME/users/octocat/repos", "events_url": "https://HOSTNAME/users/octocat/events{/privacy}", "received_events_url": "https://HOSTNAME/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-18T23:23:56Z", "updated_at": "2011-04-18T23:23:56Z", "author_association": "COLLABORATOR" } ]

Create a gist comment

"Create a gist comment"에 대한 매개 변수

헤더
Name, 형식, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
Name, 형식, 설명
gist_id string 필수

The unique identifier of the gist.

본문 매개 변수
Name, 형식, 설명
body string 필수

The comment text.

"Create a gist comment"에 대한 HTTP 응답 상태 코드

상태 코드Description
201

Created

304

Not modified

403

Forbidden

404

Resource not found

"Create a gist comment"에 대한 코드 샘플

post/gists/{gist_id}/comments
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/gists/GIST_ID/comments \ -d '{"body":"This is a comment to a gist"}'

Response

Status: 201
{ "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", "url": "https://HOSTNAME/gists/a6db0bec360bb87e9418/comments/1", "body": "Just commenting for the sake of commenting", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://HOSTNAME/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://HOSTNAME/users/octocat/followers", "following_url": "https://HOSTNAME/users/octocat/following{/other_user}", "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}", "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions", "organizations_url": "https://HOSTNAME/users/octocat/orgs", "repos_url": "https://HOSTNAME/users/octocat/repos", "events_url": "https://HOSTNAME/users/octocat/events{/privacy}", "received_events_url": "https://HOSTNAME/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-18T23:23:56Z", "updated_at": "2011-04-18T23:23:56Z", "author_association": "COLLABORATOR" }

Get a gist comment

"Get a gist comment"에 대한 매개 변수

헤더
Name, 형식, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
Name, 형식, 설명
gist_id string 필수

The unique identifier of the gist.

comment_id integer 필수

The unique identifier of the comment.

"Get a gist comment"에 대한 HTTP 응답 상태 코드

상태 코드Description
200

OK

304

Not modified

403

Forbidden Gist

404

Resource not found

"Get a gist comment"에 대한 코드 샘플

get/gists/{gist_id}/comments/{comment_id}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/gists/GIST_ID/comments/COMMENT_ID

Response

Status: 200
{ "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", "url": "https://HOSTNAME/gists/a6db0bec360bb87e9418/comments/1", "body": "Just commenting for the sake of commenting", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://HOSTNAME/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://HOSTNAME/users/octocat/followers", "following_url": "https://HOSTNAME/users/octocat/following{/other_user}", "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}", "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions", "organizations_url": "https://HOSTNAME/users/octocat/orgs", "repos_url": "https://HOSTNAME/users/octocat/repos", "events_url": "https://HOSTNAME/users/octocat/events{/privacy}", "received_events_url": "https://HOSTNAME/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-18T23:23:56Z", "updated_at": "2011-04-18T23:23:56Z", "author_association": "COLLABORATOR" }

Update a gist comment

"Update a gist comment"에 대한 매개 변수

헤더
Name, 형식, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
Name, 형식, 설명
gist_id string 필수

The unique identifier of the gist.

comment_id integer 필수

The unique identifier of the comment.

본문 매개 변수
Name, 형식, 설명
body string 필수

The comment text.

"Update a gist comment"에 대한 HTTP 응답 상태 코드

상태 코드Description
200

OK

404

Resource not found

"Update a gist comment"에 대한 코드 샘플

patch/gists/{gist_id}/comments/{comment_id}
curl -L \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/gists/GIST_ID/comments/COMMENT_ID \ -d '{"body":"This is an update to a comment in a gist"}'

Response

Status: 200
{ "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", "url": "https://HOSTNAME/gists/a6db0bec360bb87e9418/comments/1", "body": "Just commenting for the sake of commenting", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://HOSTNAME/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://HOSTNAME/users/octocat/followers", "following_url": "https://HOSTNAME/users/octocat/following{/other_user}", "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}", "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions", "organizations_url": "https://HOSTNAME/users/octocat/orgs", "repos_url": "https://HOSTNAME/users/octocat/repos", "events_url": "https://HOSTNAME/users/octocat/events{/privacy}", "received_events_url": "https://HOSTNAME/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-18T23:23:56Z", "updated_at": "2011-04-18T23:23:56Z", "author_association": "COLLABORATOR" }

Delete a gist comment

"Delete a gist comment"에 대한 매개 변수

헤더
Name, 형식, 설명
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
Name, 형식, 설명
gist_id string 필수

The unique identifier of the gist.

comment_id integer 필수

The unique identifier of the comment.

"Delete a gist comment"에 대한 HTTP 응답 상태 코드

상태 코드Description
204

No Content

304

Not modified

403

Forbidden

404

Resource not found

"Delete a gist comment"에 대한 코드 샘플

delete/gists/{gist_id}/comments/{comment_id}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/gists/GIST_ID/comments/COMMENT_ID

Response

Status: 204