GraphQL API 쿼리 및 뮤테이션 실행
이 가이드는 GitLab GraphQL API의 기본 사용법을 보여줍니다.
개발을 원하는 개발자를 대상으로 한 구현 세부 정보를 위해 GraphQL API 스타일 가이드를 참조하세요.
예제 실행하기
여기서 문서화된 예제는 다음을 사용하여 실행할 수 있습니다:
GraphiQL
GraphiQL(발음은 “그래피컬”)은 실제 GraphQL 쿼리를 상호적으로 실행할 수 있도록 합니다. 구문 강조와 자동 완성을 제공하여 스키마 탐색을 쉽게 만들어줍니다.
대부분의 사람들에게 GraphiQL을 사용하는 것이 GitLab GraphQL API를 탐색하는 가장 쉬운 방법일 것입니다.
GraphiQL을 사용할 수 있습니다.
- GitLab.com.
- 자체 관리 GitLab 인스턴스에서,
https://<your-gitlab-site.com>/-/graphql-explorer로 이동합니다.
먼저 GitLab에 로그인하여 GitLab 계정으로 요청을 인증합니다.
시작하려면 예제 쿼리와 뮤테이션을 참조하세요.
커맨드 라인
로컬 컴퓨터의 명령줄에서 curl 요청을 사용하여 GraphQL 쿼리를 실행할 수 있습니다. 요청은 쿼리를 페이로드로 하는 /api/graphql로 POST됩니다. 개인 액세스 토큰을 생성하여 해당 토큰을 bearer 토큰으로 사용하여 요청을 인증할 수 있습니다. GraphQL 인증에 대해 더 알아보세요.
예시:
GRAPHQL_TOKEN=<your-token>
curl "https://gitlab.com/api/graphql" --header "Authorization: Bearer $GRAPHQL_TOKEN" \
--header "Content-Type: application/json" --request POST \
--data "{\"query\": \"query {currentUser {name}}\"}"
쿼리 문자열 안에 문자열을 중첩시키려면, 데이터를 작은 따옴표로 묶거나, 문자열을 \\로 이스케이프하세요:
curl "https://gitlab.com/api/graphql" --header "Authorization: Bearer $GRAPHQL_TOKEN" \
--header "Content-Type: application/json" --request POST \
--data '{"query": "query {project(fullPath: \"<group>/<subgroup>/<project>\") {jobs {nodes {id duration}}}}"}'
# 또는 "{\"query\": \"query {project(fullPath: \\\"<group>/<subgroup>/<project>\\\") {jobs {nodes {id duration}}}}\"}"
Rails 콘솔
GraphQL 쿼리는 Rails 콘솔 세션에서 실행할 수 있습니다. 예를 들어, 프로젝트를 검색하려면:
current_user = User.find_by_id(1)
query = <<~EOQ
query securityGetProjects($search: String!) {
projects(search: $search) {
nodes {
path
}
}
}
EOQ
variables = { "search": "gitlab" }
result = GitlabSchema.execute(query, variables: variables, context: { current_user: current_user })
result.to_h
쿼리 및 뮤테이션
GitLab GraphQL API를 사용하여 다음을 수행할 수 있습니다:
- 데이터 검색에 대한 쿼리.
- 데이터 생성, 업데이트 및 삭제를 위한 변이.
GitLab GraphQL 스키마는 클라이언트가 쿼리할 수 있는 객체 및 필드, 그리고 해당 데이터 유형을 개요화합니다.
예시: 현재 인증된 사용자가 액세스할 수 있는 그룹 gitlab-org의 모든 프로젝트의 이름만 가져옵니다(제한 사항 존재).
query {
group(fullPath: "gitlab-org") {
id
name
projects {
nodes {
name
}
}
}
}
예시: 특정 프로젝트 및 이슈 #2의 제목 가져오기.
query {
project(fullPath: "gitlab-org/graphql-sandbox") {
name
issue(iid: "2") {
title
}
}
}
그래프 탐색
하위 노드를 검색할 때:
-
edges { node { } }구문. - 단축 형태인
nodes { }구문을 사용합니다.
이 모든 것의 근간은 우리가 탐색하는 그래프입니다. 그러므로 GraphQL이라는 이름이 붙여진 것입니다.
예시: 프로젝트의 이름과 해당 모든 이슈의 제목 가져오기.
query {
project(fullPath: "gitlab-org/graphql-sandbox") {
name
issues {
nodes {
title
description
}
}
}
}
쿼리에 대해 더 알아보기: GraphQL 문서
권한 부여
GitLab에 로그인하여 GraphiQL을 사용하면 모든 쿼리가 인증된 사용자인 당신을 통해 수행됩니다. 자세한 정보는 GraphQL 인증을 읽어보세요.
변이
변이는 데이터를 변경합니다. 우리는 업데이트하거나 삭제하거나 새로운 레코드를 생성할 수 있습니다. 변이는 일반적으로 여기서 나타나지 않는 InputTypes 및 변수를 사용합니다.
변이에는 다음이 있습니다.
- 입력값. 예를 들어, 추가하려는 이모지 반응 및 어느 객체에 추가할지와 같은 인수.
- 반환문. 즉, 성공시 얻고 싶은 내용.
- 오류. 만약를 대비해 뭔가 잘못된 것이 있을 때 항상 확인하세요.
생성 변이
예시: 차를 마시자 - 이슈에 :tea: 반응 이모지를 추가합니다.
mutation {
awardEmojiAdd(input: { awardableId: "gid://gitlab/Issue/27039960",
name: "tea"
}) {
awardEmoji {
name
description
unicode
emoji
unicodeVersion
user {
name
}
}
errors
}
}
예시: 이슈에 댓글 추가. 이 예시에서는 GitLab.com 이슈의 ID를 사용합니다. 로컬 인스턴스를 사용하는 경우 쓸 수 있는 이슈의 ID를 얻어야 합니다.
mutation {
createNote(input: { noteableId: "gid://gitlab/Issue/27039960",
body: "*차 마실래요*"
}) {
note {
id
body
discussion {
id
}
}
errors
}
}
업데이트 변이
당신이 생성한 노트의 결과 id를 확인했을 때, 기억해 두세요. 더 빨리 차를 마실 수 있도록 내용을 편집해 봅시다.
mutation {
updateNote(input: { id: "gid://gitlab/Note/<note ID>",
body: "*차 마실래요*"
}) {
note {
id
body
}
errors
}
}
삭제 변이
우리의 차가 모두 떨어졌으므로 댓글을 지워 봅시다.
mutation {
destroyNote(input: { id: "gid://gitlab/Note/<note ID>" }) {
note {
id
body
}
errors
}
}
다음과 같은 출력이 나와야 합니다.
{
"data": {
"destroyNote": {
"errors": [],
"note": null
}
}
}
우리는 노트 세부 정보를 요청했지만, 이제는 더 이상 존재하지 않으므로 null을 받습니다.
변이에 대해 더 알아보기: GraphQL Documentation.
프로젝트 설정 업데이트
하나의 GraphQL 변이로 여러 프로젝트 설정을 업데이트할 수 있습니다.
이 예시는 CI_JOB_TOKEN 스코핑 동작에 관한 중요한 변경에 대한 해결책입니다.
mutation DisableCI_JOB_TOKENscope {
projectCiCdSettingsUpdate(input:{fullPath: "<namespace>/<project-name>", inboundJobTokenScopeEnabled: false}) {
ciCdSettings {
inboundJobTokenScopeEnabled
}
errors
}
}
자가 질문
클라이언트는 자가 질문을 만들어 스키마에 대한 정보를 가져올 수 있습니다. GraphiQL Query Explorer은 다음을 위해 자가 질문을 사용합니다.
- GitLab GraphQL 스키마에 대한 정보 수집
- 자동완성
- 대화식
Docs탭 제공
예시: 스키마에 있는 모든 유형 이름 가져오기.
{
__schema {
types {
name
}
}
}
예시: 이슈와 관련된 모든 필드 가져오기. kind는 유형에 대한 열거형 값인 OBJECT, SCALAR 또는 INTERFACE를 알려줍니다.
query IssueTypes {
__type(name: "Issue") {
kind
name
fields {
name
description
type {
name
}
}
}
}
자가 질문에 대해 더 알아보기: GraphQL documentation
질의 복잡도
질의의 계산된 복잡도 점수 및 제한은 queryComplexity를 질의함으로써 클라이언트에게 공개될 수 있습니다.
query {
queryComplexity {
score
limit
}
project(fullPath: "gitlab-org/graphql-sandbox") {
name
}
}
정렬
GitLab GraphQL 엔드포인트 중 일부는 객체 컬렉션을 정렬하는 방법을 지정할 수 있습니다. 스키마에서 허용하는 대로만 정렬할 수 있습니다.
예시: 이슈를 생성 날짜로 정렬할 수 있습니다.
query {
project(fullPath: "gitlab-org/graphql-sandbox") {
name
issues(sort: created_asc) {
nodes {
title
createdAt
}
}
}
}
페이지네이션
페이지네이션은 레코드의 일부분만 요청하는 방법으로, 예를 들어 첫 10개의 레코드를 요청합니다. 더 많은 레코드를 원할 경우, 다음 열 개의 레코드를 서버에게 요청하여 받을 수 있습니다.
기본적으로 GitLab GraphQL API는 페이지당 100개의 레코드를 반환합니다. 이 동작을 변경하려면 first 또는 last 인수를 사용합니다. 두 인수 모두 값을 받으며, 예를 들어 first: 10은 첫 10개의 레코드를 반환하고, last: 10은 마지막 10개의 레코드를 반환합니다. 페이지당 반환되는 레코드 수에는 일반적으로 100이라는 제한이 있습니다.
예시: 처음 두 개의 이슈만 가져오기(슬라이싱). cursor 필드는 해당 위치부터 상대적으로 더 많은 레코드를 검색할 수 있는 위치를 제공합니다.
query {
project(fullPath: "gitlab-org/graphql-sandbox") {
name
issues(first: 2) {
edges {
node {
title
}
}
pageInfo {
endCursor
hasNextPage
}
}
}
}
예시: 다음 세 개를 가져오기. (커서 값 eyJpZCI6IjI3MDM4OTMzIiwiY3JlYXRlZF9hdCI6IjIwMTktMTEtMTQgMDU6NTY6NDQgVVRDIn0는 달라질 수 있지만, 다음에 반환된 커서 값입니다.)
query {
project(fullPath: "gitlab-org/graphql-sandbox") {
name
issues(first: 3, after: "eyJpZCI6IjI3MDM4OTMzIiwiY3JlYXRlZF9hdCI6IjIwMTktMTEtMTQgMDU6NTY6NDQgVVRDIn0") {
edges {
node {
title
}
cursor
}
pageInfo {
endCursor
hasNextPage
}
}
}
}
페이지네이션과 커서에 대한 자세한 내용은 GraphQL 문서를 참조하세요.
도움말