GraphQL API 쿼리 및 뮤테이션 실행

Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

이 가이드는 GitLab GraphQL API의 기본 사용법을 보여줍니다.

개발자로서 API 자체를 개발하려는 사람들을 대상으로 한 구현 세부 정보를 위해 GraphQL API 스타일 가이드를 읽어보세요.

예시 실행

여기서 문서화된 예시는 다음을 사용하여 실행할 수 있습니다:

GraphiQL

GraphiQL(발음: “그래피컬”)을 사용하면 API와 실시간으로 GraphQL 쿼리를 실행할 수 있습니다. 구문 강조와 자동 완성이 있는 UI를 제공하여 스키마를 탐색하기를 쉽게 만듭니다.

대부분의 경우, GitLab GraphQL API를 탐색하는 가장 쉬운 방법일 것입니다.

다음 중 하나를 사용할 수 있습니다:

  • GitLab.com에서 사용합니다.
  • https://<your-gitlab-site.com>/-/graphql-explorer에 있는 Self-managed GitLab 인스턴스에서 사용합니다.

먼저 GitLab에 로그인하여 요청을 인증하세요.

시작하려면 예시 쿼리 및 뮤테이션을 참조하세요.

명령줄

로컬 컴퓨터의 명령줄에서 curl 요청을 사용하여 GraphQL 쿼리를 실행할 수 있습니다. 요청은 쿼리를 페이로드로 하는 /api/graphql로 POST됩니다. 개인 액세스 토큰을 생성하여 요청을 인가할 수 있습니다. GraphQL Authentication에 대해 자세히 알아보세요.

예시: 

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 콘솔

Tier: Free, Premium, Ultimate Offering: Self-managed, GitLab Dedicated

Rails 콘솔 세션에서 GraphQL 쿼리를 실행할 수 있습니다. 예를 들어, 프로젝트를 검색하는 경우: 

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를 사용하여 다음을 수행할 수 있습니다:

  • 데이터 검색을 위한 쿼리.
  • 뮤테이션을 통해 데이터를 만들거나 업데이트하고 삭제합니다.
note
GitLab GraphQL API에서 id는 "gid://gitlab/Issue/123" 형식의 Global ID로 객체 식별자를 나타냅니다. 자세한 내용은 Global IDs를 참조하세요.

GitLab GraphQL 스키마에서는 클라이언트가 쿼리할 수 있는 객체와 필드, 그리고 해당 데이터 유형을 개요로 제공합니다.

예시: 현재 인증된 사용자가 액세스할 수 있는 모든 프로젝트의 이름만 가져오기(제한까지). 

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 documentation

인증

GitLab에 로그인하고 GraphiQL을 사용하면 모든 쿼리가 인증된 사용자인 여러분으로 실행됩니다. 자세한 내용은 GraphQL Authentication을 읽어보세요.

뮤테이션

뮤테이션은 데이터를 변경합니다. 새 레코드를 만들거나 업데이트하거나 삭제할 수 있습니다. 뮤테이션은 일반적으로 여기에는 나오지 않는 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: "*sips tea*"
    }) {
    note {
      id
      body
      discussion {
        id
      }
    }
    errors
  }
}

변경 사항 뮤테이션

노트를 만든 결과의 id를 확인하고 기록하세요. 빨리 한 모금 마시도록 편집합시다. 

mutation {
  updateNote(input: { id: "gid://gitlab/Note/<노트 ID>",
      본문: "*차를 마시는 중*"
    }) {
    note {
      id
      body
    }
    errors
  }
}

삭제 뮤테이션

차가 다 떨어졌으니, 댓글을 삭제합시다. 

mutation {
  destroyNote(input: { id: "gid://gitlab/Note/<노트 ID>" }) {
    note {
      id
      body
    }
    errors
  }
}

다음과 같은 출력을 받아야 합니다: 

{
  "data": {
    "destroyNote": {
      "errors": [],
      "note": null
    }
  }
}

노트 세부 정보를 요청했지만, 더는 존재하지 않아 null을 얻습니다.

뮤테이션에 대해 더 알아보기: GraphQL 문서.

프로젝트 설정 업데이트

하나의 GraphQL 뮤테이션으로 여러 프로젝트 설정을 업데이트할 수 있습니다. 이 예시는 CI_JOB_TOKEN 범위 행동의 중요한 변경에 대한 해결책입니다. 

mutation DisableCI_JOB_TOKENscope {
  projectCiCdSettingsUpdate(input:{fullPath: "<네임스페이스>/<프로젝트-이름>", 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 문서

쿼리 복잡도

쿼리의 계산된 복잡도 점수와 제한은 클라이언트에게 노출될 수 있습니다. 

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
      }
    }
  }
}

페이지네이션

페이지네이션은 처음 열 개의 레코드와 같이 레코드의 하위 집합만 요청하는 방법입니다. 더 많은 레코드가 필요하면, 다음 열 개를 요청하기 위해 서버에서 추가 요청을 할 수 있습니다.

기본적으로 GitLab GraphQL API는 페이지당 100개의 레코드를 반환합니다. 이 동작을 변경하려면 first 또는 last 인수를 사용합니다. 두 인수 모두 값을 취하므로, first: 10은 처음 열 개의 레코드를 반환하고, last: 10은 마지막 열 개의 레코드를 반환합니다. 페이지당 반환되는 레코드 수에는 일반적으로 100의 제한이 있습니다.

예시: 처음 두 개의 이슈만 가져오기 (슬라이싱). cursor 필드는 해당 위치인 디렉터리부터 추가 레코드를 검색할 수 있는 위치를 제공합니다. 

query {
  project(fullPath: "gitlab-org/graphql-sandbox") {
    name
    issues(first: 2) {
      edges {
        node {
          title
        }
      }
      pageInfo {
        endCursor
        hasNextPage
      }
    }
  }
}

예시: 다음 세 개 가져오기. (커서 값 eyJpZCI6IjI3MDM4OTMzIiwiY3JlYXRlZF9hdCI6IjIwMTktMTEtMTQgMDU6NTY6NDQgVVRDIn0가 다를 수도 있지만, 위에서 반환된 두 번째 이슈의 cursor 값입니다.) 

query {
  project(fullPath: "gitlab-org/graphql-sandbox") {
    name
    issues(first: 3, after: "eyJpZCI6IjI3MDM4OTMzIiwiY3JlYXRlZF9hdCI6IjIwMTktMTEtMTQgMDU6NTY6NDQgVVRDIn0") {
      edges {
        node {
          title
        }
        cursor
      }
      pageInfo {
        endCursor
        hasNextPage
      }
    }
  }
}

페이지네이션과 커서에 대해 더 알아보기: GraphQL 문서