GraphQL?

한국어 공식 사이트에서는 다음과 같이 소개한다.

API를 위한 쿼리 언어

GraphQL은 API를 위한 쿼리 언어이며 이미 존재하는 데이터로 쿼리를 수행하기 위한 런타임 입니다. GraphQL은 API에 있는 데이터에 대한 완벽하고 이해하기 쉬운 설명을 제공하고 클라이언트에게 필요한 것을 정확하게 요청할 수 있는 기능을 제공하며 시간이 지남에 따라 API를 쉽게 진화시키고 강력한 개발자 도구를 지원합니다.

GraphQL을 사용하면 API 엔드포인트를 최소화하게 된다. GraphQL을 처리하는 엔드포인트 하나만 서비스하게 되는 경우도 가능하기 때문이다. 한편, 쿼리에 포함시킬 타입에 대한 고민을 많이 하게 될 수 있다.

GraphQL을 사용하면 API 설계 과정이 바뀔 수도 있습니다. API가 엔드포인트의 집합이 아니라 타입 집합으로 보이게 됩니다. 1

SQL과 GraphQL

SQL을 사용해 본 적이 있다면 SQL의 개념과 대비해 GraphQL을 이해할 수 있다고 생각한다.

  • GraphQL은 SQL과 같이 선언적인 쿼리문을 특정 서버로 전달하며,
    • 쿼리문을 전달받은 서버는 쿼리를 해석해 데이터를 조회하거나 업데이트하고,
    • 그 결과를 쿼리에서 요청한 형식에 맞게 구성해 리턴해 주는 것이다.

Learning GraphQL에서는 이와 비슷한 설명이 나온다.

GraphQL은 쿼리 데이터베이스용으로 만들어진 개념을 가져다가 인터넷에 적용해 만들어진 것입니다. GraphQL 쿼리 하나로 여기저기 흩어져 있는 데이터를 한데 모아 받습니다. SQL처럼 GraphQL 쿼리도 데이터를 변경하거나 삭제할 때 사용합니다. SQL의 QL과 GraphQL의 QL은 둘 다 마찬가지로 쿼리 언어(Query Language)라는 뜻입니다. 2

간단한 조회 쿼리를 두고 소박하게 비교해 보자. 이 표의 각 단계와 작업 내용은 내가 이해하기 위해 상상해 작성한 것으로 실제 구현과는 다를 수 있다.

순서 SQL GraphQL
1 SELECT 조회문을 SQL 문법에 맞게 작성한다. query 조회문을 GraphQL 문법에 맞게 작성한다.
2 작성한 조회문을 DB로 보낸다. 작성한 조회문을 HTTP를 통해 API 서버로 보낸다.
3 DB의 SQL 검사기는 쿼리의 문법을 검사한다. API 서버의 GraphQL 라이브러리는 쿼리의 문법을 검사한다.
4 DB의 SQL 검사기는 조회 대상 table, column 등이 유효한지 검사한다. GraphQL 라이브러리는 조회 대상 schema가 유효한지 검사한다.
5 데이터를 조회한다. (join도 한다.) 서버 개발자가 작성한 각 필드에 대응하는 resolver 함수가 각 필드의 데이터를 조회해 리턴한다.
6 조회된 데이터를 요청한 형식에 맞게 구성한다. GraphQL 라이브러리는 resolver가 리턴한 결과를 요청한 형식에 맞게 구성한다.
7 구성한 데이터 결과 셋을 돌려준다. 구성한 데이터를 HTTP 응답으로 돌려준다.

따라서 GraphQL을 단순한 조회/업데이트 API를 대체하는 용도로 사용하고자 한다면 다음과 같은 작업을 해야 할 수 있다.

  • GraphQL query에서 사용할 schema를 정의해서, 서버 애플리케이션의 GraphQL 라이브러리가 참조할 GraphQL schema 파일에 추가한다.
  • 각 schema 타입별 resolver 함수를 작성한다.
    • resolver 함수는 DB에서 값을 조회해오거나, 업데이트 요청을 보낼 수 있으므로 SQL이나 ORM을 쓸 수 있다.
  • API 요청을 받는 컨트롤러와 resolver 함수를 연결해 준다.

GraphQL의 도입으로 기대할 수 있는 것들

github은 API v4부터 GraphQL을 사용하고 있으며, 다음과 같이 이유를 밝힌다.

Why GitHub is using GraphQL

GitHub chose GraphQL for our API v4 because it offers significantly more flexibility for our integrators. The ability to define precisely the data you want—and only the data you want—is a powerful advantage over the REST API v3 endpoints. GraphQL lets you replace multiple REST requests with a single call to fetch the data you specify.

For more details about why GitHub has moved to GraphQL, see the original announcement blog post.

Github이 GraphQL을 사용하는 이유

Github은 API v4에 GraphQL을 선택했으며, 그 이유는 GraphQL이 사용자(integrators)에게 훨씬 더 많은 유연성을 제공해주기 때문입니다. 원하는 데이터만 정확하게 정의하는 GraphQL의 기능은 REST API v3 엔드포인트와 대비되는 강력한 장점입니다. GraphQL을 사용하면 여러 REST 요청을 한 번의 호출로 지정한 데이터를 가져올 수 있게 됩니다.

GitHub이 GraphQL을 선택하게 된 더 자세한 이유에 대해서는 블로그의 공지글(2016년 9월 14일)을 참고하세요.

나는 GraphQL을 사용한다면 REST API에 대비해 다음과 같은 특징들을 기대할 수 있다고 생각한다.

  • over fetching을 예방할 수 있다.
    • over fetching은 API 요청 결과에 필요 없는 정보들이 포함되어 있는 것을 말한다.
    • 일반적인 REST API라면 요청을 보낼 때 응답 포맷에 대한 필터링을 정의하기 어려우므로 over fetching을 어쩔 수 없이 받아들여야 하는 경우가 많다.
  • under fetching을 예방할 수 있다.
    • under fetching은 API 요청 결과가 필요한 정보들의 부분집합인 것을 말한다.
    • under fetching 문제가 있다면 API 호출자는 여러 엔드포인트에 대한 HTTP request를 전송해 돌아온 결과를 조합해 원하는 결과를 만들어야 한다.
    • GraphQL을 사용하면 이상적인 경우, 여러 차례의 API 요청을 단 1회로 줄일 수도 있다.
    • 위의 GitHub 발표문은 GraphQL이 under fetching을 없앨 수 있다는 장점을 이야기하고 있다.
  • 요구 조건의 변화를 GraphQL 쿼리 수정으로 대응할 수 있다.
    • 새로운 REST API 엔드포인트를 추가하지 않아도, 그냥 요청 쿼리를 바꾸는 것으로 해결할 수 있는 여지가 생긴다.
    • GraphQL 요청을 받는 API 엔드포인트를 유지하기만 하면 되므로, REST API를 위한 엔드포인트의 추가/삭제는 별개의 문제이다.
  • 단순 조회 용도의 REST API를 GraphQL 엔드포인트로 합칠 수 있다.
    • 여러 개의 조회용 API 엔드포인트 주소를 GraphQL 쿼리를 받는 엔드포인트 하나로 합쳐갈 수 있다.
    • 특정 API에서의 조회 요청에 대응하는 GraphQL 스키마만 정의되어 있다면 해당 API 호출부를 GraphQL 쿼리를 만들고 GraphQL 엔드포인트를 호출하도록 수정하면 된다. 이후 문제가 없는 것을 확인하고, 오래된 API를 삭제하면 된다.
    • 쿼리를 수정하기만 하면 결과 포맷도 변경이 가능하므로, 결과 셋 형식에 대한 책임이 SQL/ORM을 사용하는 쪽에서, GraphQL 쿼리를 생성하는 쪽으로 넘어간다.

GraphQL 이모저모

schema

스키마에는 타입 정의를 모아 둡니다. 스키마는 자바스크립트 파일에 문자열로 작성하거나, 따로 텍스트 파일로 작성해 둘 수도 있습니다. 텍스트 파일의 주요 확장자는 .graphql 입니다. 3

다음은 Learning GraphQL 책 4장의 예제를 참고해 작성한 것이다.4

# 커스텀 스칼라 타입 정의
scalar DateTime

# enum 타입 정의
enum PhotoCategory {
    SELFIE
    PORTRAIT
    LANDSCAPE
}

type User {
    githubLogin: ID!
    name: String
    avatar: String
    # null을 허용하지 않는 리스트. 리스트 자체도 not null.
    postedPhotos: [Photo!]!
}

# Photo 타입 선언
type Photo {
    id: ID!
    name: String!
    url: String!          # String 타입이며, non null
    description: String   # String 타입이며, nullable
    created: DateTime!    # 커스텀 스칼라 타입
    category: PhotoCategory!
    postedBy: User!       # type 안에서 다른 type을 참조할 수 있다
}
  • !를 써서 null을 허용하지 않는다는 것을 선언할 수 있다.
  • !와 배열 []을 함께 사용하면 좀 헷갈리는데 다음과 같이 요약할 수 있다.
리스트 선언 아이템 리스트 자체 valid 예제
[Int]     null, [1, null], [1, 2]
[Int!] not null   null, [1, 2]
[Int]!   not null [1, null], [1, 2]
[Int!]! not null not null [1, 2]

query

다음은 Learning GraphQL 책 4장의 예제를 참고해 작성한 것이다.5

# 쿼리 선언
# 필수 조회 인자로 User의 githubLogin과 Photo의 id를 요구한다
type Query {
    User(githubLogin: ID!): User!
    Photo(id: ID!): Photo!
}

위에서 선언한 쿼리는 다음과 같이 사용할 수 있다.

query {
    # User 조회 조건으로 "John Doe"를 지정한다
    User(githubLogin: "John Doe") {
        name
        avatar
    }
}
  • 쿼리 선언에서는 UserPhoto를 모두 정의했다.
  • 그러나 조회 쿼리에서는 Photo가 별로 필요가 없는 상황이었는지 User만 조회해 달라고 질의하고 있다.
    • User의 필드는 여러 가지가 있는데, nameavatar만 필요했는지 이 두 가지만 조회해 달라고 질의하고 있다.

위에서 선언한 쿼리를 통해 다음과 같은 쿼리도 만들어 사용할 수 있다.

query {
    Photo(id: "14TH5B6NS4KIG3H4S") {
        name
        description
        url
    }
}
  • 이 조회 쿼리에서는 User는 필요가 없었는지 Photo만 조회하고 있다.
  • Photo또한 다양한 필드를 갖고 있지만 여기에서는 name, description, url만을 선택하고 있다.
# 페이징 쿼리 선언
type Query {
    # first는 한 페이지에 들어가는 레코드의 수 (Int=50 은 기본값)
    # start는 페이지 첫번째 레코드의 인덱스 (Int=0 은 기본값)
    allUsers(first: Int=50 start: Int=0): [User!]!
    allPhotos(first: Int=25 start: Int=0): [Photo!]!
}
  • 이 쿼리를 호출할 때 firststart 값을 제공하지 않으면 기본값을 사용한다.
# 페이징 쿼리를 사용한 조회
query {
    allUsers(first: 10 start: 90) {
        name
        avatar
    }
}
  • 90번 user부터 시작하여 10명의 user를 조회한다.
    • 각 user의 nameavatar를 선택해 조회.

이번에는 정렬 인자도 제공해 보자.

# 정렬 방향 정의
enum SortDirection {
    ASCENDING
    DESCENDING
}

# 정렬 가능한 필드 선언
enum SortablePhotoField {
    name
    description
    category
    created
}

# 정렬 쿼리 선언
Query {
    allPhotos(
        sort: SortDirection = DESCENDING
        sortBy: SortablePhotoField = created
    ): [Photo!]!
}

조회는 이렇게 할 수 있을 것이다.

query {
    allPhotos(sortBy: name)
}

물론 이렇게 스키마를 구성하고 쿼리를 정의해 서버로 보낸다고 모든 값이 자동으로 DB에서 다 조회되어 응답되는 게 아니다. 위에서 정의한 정렬 방향 정의, 정렬 가능 필드, 정렬 쿼리 등에 대해 resolver를 백엔드에서 다 만들어야 의도한대로 작동할 것이다. 지금 살펴보고 있는 것은 모두 백엔드가 작업을 완료했다는 것을 전제하고 있다.

mutation

다음은 Learning GraphQL 책 4장의 예제를 참고해 작성한 것이다.6

뮤테이션은 반드시 스키마 안에 정의해 두어야 합니다. 쿼리를 정의할 때처럼 커스텀 타입으로 정의한 다음에 스키마에 추가합니다. 엄밀히 말하자면 스키마 안에서 쿼리와 뮤테이션 작성법은 차이가 없습니다. 유일한 차이는 구문 작성 의도에서 발생합니다. 애플리케이션 상태를 바꿀 액션이나 이벤트가 있을 때만 뮤테이션을 작성해야 합니다.

뮤테이션은 애플리케이션의 동사 역할을 해야 합니다. 사용자가 GraphQL 서비스를 가지고 할 수 있는 일을 정의해야 합니다. 사용자가 GraphQL로 만든 애플리케이션에서 취할 수 있는 동작을 일단 모두 목록으로 만들어 보면, 대부분이 뮤테이션일 확률이 높습니다. 7

뮤테이션은 스키마의 루트 mutation 타입에 추가하여 클라이언트에서 사용할 수 있도록 합니다. 6

# mutation 정의
type Mutation {
    postPhoto(
        name: String!
        description: String
        category: PhotoCategory = PORTRAIT
    ): Photo!
}

schema {
    query: Query
    mutation: Mutation
}

쿼리는 다음과 같이 보낼 수 있다.

# 새로운 사진을 등록한다. 사진의 이름은 "Sending the Palisades".
mutation {
    postPhoto(name: "Sending the Palisades") {
        id
        name
        created
        postedBy { name }
    }
}
  • 사진이 어떻게 보내졌는지는 생략하고, 의미를 생각하자.
    • 사진 name은 필수값이므로 "Sending the Palisades"를 전송.
    • category는 지정하지 않았으므로, 기본값인 PORTRAIT를 전송.
  • 사진이 새로 등록되면, 등록된 사진의 id, name, createdpostedBy 등이 응답으로 돌아오게 된다.

쿼리에 변수를 사용하는 방법도 있다.

mutation postPhoto(
    $name: String!
    $description: String
    $category: PhotoCategory
) {
    postPhoto(
        name: $name
        description: $description
        category: $category
    ) {
        id
        name
        email
    }
}

이렇게 정의하고 각 변수에 해당하는 값들을 json으로 보내주는 방법이다.

{
    "name": "Sending the Palisades",
    "description": "A photo of the Palisades in the US",
    "category": "PORTRAIT"
}

input

input 타입을 사용하면 query와 mutation에서 사용하는 인자를 따로 정의해 사용할 수 있다. 물론 재활용도 가능하다.

위에서 정의한 mutation postPhoto의 세 인자 $name, $description, $categoryinput으로 분리해 보자.

다음은 Learning GraphQL 책 4장의 예제를 참고해 작성한 것이다.8

# input 정의
input PostPhotoInput {
    name: String!
    description: String
    category: PhotoCategory = PORTRAIT
}

type Mutation {
                    # ↓ 여기에서 사용한다
    postPhoto(input: PostPhotoInput): Photo!
}

이제 mutation 요청을 정의해보자.

mutation newPhoto($input: PostPhotoInput!) {
                    # ↓ 여기. 타입은 PostPhotoInput 이어야 한다.
    postPhoto(input: $input) {
        id
        url
        created
    }
}

json은 이렇게 보내면 된다.

{
    "input": {
        "name": "Hanging at the Arc",
        "description": "Sunny on the deck of the Arc",
        "category": "LANDSCAPE"
    }
}

subscription

Subscription 타입은 구독 모델을 지원한다.

다음은 Learning GraphQL 책 4장의 예제를 참고해 작성한 것이다.9

type Subscription {
    newPhoto(category: PhotoCategory): Photo!
    newUser: User!
}

schema {
    query: Query
    mutation: Mutation
    subscription: Subscription
}

요청은 다음과 같이 보낸다.

subscription {
    newPhoto(category: "ACTION") {
        id
        name
        url
        postedBy { name }
    }
}

이렇게 요청을 보내면 ACTION 카테고리에 올라온 새로운 사진을 실시간으로 구독하게 해달라고 서버에 부탁하는 것이다.

예제를 통한 연습

SWAPI로 query 조회하기

SWAPI GraphQL API에서 GraphQL을 연습해 보며 학습할 수 있다. 데이터를 조회해보면 스타워즈가 주제라는 것을 알 수 있다. (이름의 SWAPI가 Star Wars API를 의미하는 것 같다.)

다음과 같이 Query를 작성하고 전송해보자.

query {
  person(personID: 1) {
    name
  }
}

이렇게 작성한 Query는 문자열로 변환되어 HTTP request payload로 전송된다. curl로 표현하자면 다음과 같다.

curl 'https://swapi-graphql.netlify.app/.netlify/functions/index' \
  -H 'content-type: application/json' \
  --data-raw '{"query":"query { person(personID: 1) { name }}","variables":null}'

응답은 다음과 같이 돌아온다.

{
  "data": {
    "person": {
      "name": "Luke Skywalker"
    }
  }
}

Query를 수정해서 더 많은 내용을 조회할 수도 있다. 엔드포인트가 같은데도 Query를 수정하는 것만으로도 다른 정보를 얻을 수 있다는 점에 주목하자.

query {
  person(personID: 1) {
    name
    eyeColor
    homeworld {
      name
    }
  }
}

이 요청 또한 다음과 같은 요청으로 보내진다. 엔드포인트가 똑같지만 payload에 담긴 쿼리만 다르다는 점에 주목하자.

curl 'https://swapi-graphql.netlify.app/.netlify/functions/index' \
  -H 'content-type: application/json' \
  --data-raw '{"query":"query { person(personID: 1) { name eyeColor homeworld { name }}}","variables":null}'

결과는 다음과 같다.

{
  "data": {
    "person": {
      "name": "Luke Skywalker",
      "eyeColor": "blue",
      "homeworld": {
        "name": "Tatooine"
      }
    }
  }
}

github API

github의 Introduction to GraphQL을 읽으며 GitHub의 GraphQL playground에서 연습해보자.

query

다음은 GitHub의 예제 쿼리를 일부 수정해 본 것이다. (편의상 닫는 중괄호는 한 줄로 모아 두었다.) 이 웹 사이트의 issues에서 최초의 2개 이슈를 조회하는 내용이다.

query {
  repository(owner: "johngrib", name: "johngrib.github.io") {
    issues(first: 2, states: CLOSED) {
      edges {
        node {
          title
          url
          labels(first: 5) {
            edges {
              node {
                name } } } } } } } }
  • query: 조회 요청을 선언한다. 조회가 아니라 업데이트 요청이라면 query가 아니라 mutation 키워드를 사용한다.
  • repository: repository 조회 요청. 스키마를 확인해 보면 repository 조회 요청은 Repository 타입을 리턴한다.
    • (owner: "johngrib", name: "johngrib.github.io"): 검색 조건. github 사용자와 repository 이름.
    • issues: Repository 타입에 포함된 issue 조회 요청. 스키마를 확인해 보면 issues 조회 요청은 IssueConnection 타입을 리턴한다.
      • (first: 2, states: CLOSED): 조회 조건. 최초 2개의 이슈를 조회하고, CLOSED 상태인 것만 조회.
      • edges: IssueConnection 타입에 포함된 IssueEdge 타입 조회 요청.

위의 쿼리를 GitHub의 GraphQL playground에서 실행하면 다음과 같은 결과가 나온다.

johngrib 쿼리 실행 결과

github의 public-schema(백업파일, 백업gist)는 47000 라인이 넘는 아주 긴 파일인데, 다음은 이 스키마 파일에서 위의 repository 조회 쿼리만 뽑아 읽기 쉽게 재구성한 것이다. 10

"""
The query root of GitHub's GraphQL interface.
"""
type Query {

  """
  Lookup a given repository by the owner and repository name.
  """
  repository(
    """
    Follow repository renames. If disabled, a repository referenced by its old name will return an error.
    """
    followRenames: Boolean = true

    """
    The name of the repository
    """
    name: String!

    """
    The login field of a user or organization
    """
    owner: String!
  ): Repository
}

읽어보면 여기에서 정의된 followRenames, owner, name 중 두 가지를 repository 조회에 사용했다는 것을 알 수 있다.

조회 결과는 Repository 타입이며, 다음은 스키마 파일에서 필요한 부분만 뽑아 재구성한 것이다. 11

"""
A repository contains the content for a project.
"""
type Repository implements Node & PackageOwner & ProjectOwner & RepositoryInfo & Starrable & Subscribable & UniformResourceLocatable {

  """
  A list of issues that have been opened in the repository.
  """
  issues(
    """
    Returns the first _n_ elements from the list.
    """
    first: Int

    """
    A list of states to filter the issues by.
    """
    states: [IssueState!]
  ): IssueConnection!

type Repository

issues를 통해 조회되는 타입은 IssueConnection로 연결되고.. 계속 이렇게 그래프 구조를 이루며 내려간다.

mutation

이번엔 github 예제를 따라 mutation 요청을 보내보자.

다음 query는 github.com/octocat/Hello-World 리포지토리의 349번 이슈의 아이디를 조회한다.

query FindIssueID {
  repository(owner:"octocat", name:"Hello-World") {
    issue(number:349) {
      id
    }
  }
}

위의 query를 실행하면 해당 이슈의 아이디를 얻을 수 있다.

{
  "data": {
    "repository": {
      "issue": {
        "id": "MDU6SXNzdWUyMzEzOTE1NTE="
      }
    }
  }
}

아이디가 MDU6SXNzdWUyMzEzOTE1NTE=라는 것을 확인하자.

base64로 인코딩한 값이라는 감이 온다. 이 값을 base64 명령으로 디코딩하면 평문을 확인할 수 있다.

$ pbpaste | base64 --decode
05:Issue231391551

349번 이슈로 찾아가서 조사해보면 231391551이 이 이슈의 아이디인 것으로 보인다. (모든 github 이슈들의 고유한 AUTO_INCREMENT 값이 아닐까 싶다.)

issue 231391551

mutation 요청을 보낼 대상은 다 확인했으므로, mutation 요청을 읽어보자.

mutation AddReactionToIssue {
  addReaction(input:{subjectId:"MDU6SXNzdWUyMzEzOTE1NTE=",content:HOORAY}) {
    reaction {
      content
    }
    subject {
      id
    }
  }
}

두 개의 parameter를 사용하고 있다.

  • subjectId:"MDU6SXNzdWUyMzEzOTE1NTE=": base64로 인코딩한 349번 이슈의 아이디.
  • content:HOORAY: 해당 이슈에 남길 이모지.

이제 요청을 보내보자.

mutation 요청과 그 결과

보낸 값에 대한 다른 표현이 응답으로 돌아온다.

이제 349번 이슈로 돌아가 이모지를 확인해 보자.

before mutation 전
after mutation 후

파티 폭죽 모양의 이모지(🎉)가 추가되어 있다.

이제 스키마를 찾아보자. addReaction 요청은 이렇게 되어 있다. 12

  """
  Adds a reaction to a subject.
  """
  addReaction(
    """
    Parameters for AddReaction
    """
    input: AddReactionInput!
  ): AddReactionPayload

addReaction(..)

input으로 AddReactionInput을 사용하며, 요청에 대해 AddReactionPayload 타입을 응답한다.

AddReactionInput은 이렇게 되어 있다. 13

"""
Autogenerated input type of AddReaction
"""
input AddReactionInput {
  """
  The name of the emoji to react with.
  """
  content: ReactionContent!

  """
  The Node ID of the subject to modify.
  """
  subjectId: ID!
    @possibleTypes(
      concreteTypes: [
        "CommitComment"
        "Discussion"
        "DiscussionComment"
        "Issue"
        "IssueComment"
        "PullRequest"
        "PullRequestReview"
        "PullRequestReviewComment"
        "Release"
        "TeamDiscussion"
        "TeamDiscussionComment"
      ]
      abstractType: "Reactable"
    )
}

input AddReactionInput {..}

결과 응답인 AddReactionPayload는 다음과 같이 정의되어 있다. 14

"""
Autogenerated return type of AddReaction
"""
type AddReactionPayload {
  """
  A unique identifier for the client performing the mutation.
  """
  clientMutationId: String

  """
  The reaction object.
  """
  reaction: Reaction

  """
  The reactable subject.
  """
  subject: Reactable
}

type AddReactionPayload {..}

GraphQL 공식 사이트 예제 참고

GraphQL 소개

https://graphql-kr.github.io/learn/

다음과 같이 스키마를 구성해 두었다고 하자.

type Query {
  me: User
}

type User {
  id: ID
  name: String
}

그리고 위의 두 타입에 대해 아래와 같은 Javascript 함수를 작성하였다고 하자.

function Query_me(request) {
  return request.auth.user;
}

function User_name(user) {
  return user.getName();
}

각 함수가 return request...와 같은 형태를 취하고 있는데, 이렇게 해야만 하는 건 아니고 실제로는 저 함수 안쪽에서 DB를 조회해서 조회한 결과를 리턴한다던가 하게 된다. 예제를 단순하게 표현하기 위해 request에 포함된 값을 그냥 돌려주는 것일 뿐이다.

이 때 이렇게 쿼리를 작성해 전송하면 결과는 다음과 같다.

쿼리 결과
query {
  me {
    name
  }
}
{
  "me": {
    "name": "Luke Skywalker"
  }
}
  • 이 결과를 만들기 위해 위에서 만든 두 개의 함수가 사용된다.
  • me를 조회하기 위해 Query_me 함수를 호출하고, 그 결과에서 name을 완성해주기 위해 User_name 함수를 호출하게 되는 것.
  • meQuery_me의 관계, 그리고 nameUser_name의 관계는 자동으로 되는 건 아니고 따로 다른 곳에서 연결해줘야 한다.

operation name

https://graphql.org/learn/queries/#operation-name

query HeroNameAndFriends {
  hero { name }
}
  • query는 operation type.
    • query는 생략 가능하지만 가급적이면 생략하지 않도록 하자.
  • HeroNameAndFriends는 operation name.
    • operation name은 이름을 붙인 쿼리를 만들어 계속 재활용할 수 있게 한다.
    • 조회를 요청하는 쪽에 무한한 권한을 줄 수는 없으니 이런 이름을 붙인 쿼리를 적절히 잘 사용해야 한다.
  • operation type
    • 조회에 사용하는 query
    • 업데이트에 사용하는 mutation
    • 구독에 사용하는 subscription

variables

https://graphql.org/learn/queries/#variables

다음과 같이 변수와, 변수 기본값을 지정할 수 있다.

query HeroNameAndFriends($episode: Episode = "JEDI") {
  hero(episode: $episode) {
    name
    friends { name }
  } }

arguments

https://graphql.org/learn/queries/#arguments

쿼리 결과
query {
  human(id: "1000") {   # id가 인자
    name
    height(unit: FOOT)  # unit이 인자
  } }
{
  "data": {
    "human": {
      "name": "Luke Skywalker",
      "height": 5.6430448
    } } }
query {
  hero(episode: EMPIRE) {
    name
    friends {
      name
    } } }
{
  "data": {
    "hero": {
      "name": "Luke Skywalker",
      "friends": [
        { "name": "Han Solo" },
        { "name": "Leia Organa" },
        { "name": "C-3PO" },
        { "name": "R2-D2" }
      ] } } }
  • id, unit, episode가 인자에 해당한다.
    • 인자가 계층 구조의 여러 곳에 들어갈 수 있다는 점에 주목하자.
    • id는 String 타입 인자.
    • unitepisode는 enum 타입 인자.
  • 인자를 받는 함수가 어떻게 구현되었는지에 따라 인자의 용도가 다르다.
    • human에서 id는 조회 기준이었는데, height에서 unit은 단위 지정이다.
    • 함수가 어떤 결과를 리턴할지는 함수를 만든 사람 마음이다. 동료들과 잘 이야기하며 정해야 하는 문제이다.

aliases

https://graphql.org/learn/queries/#aliases

쿼리 결과
query {
  empireHero: hero(episode: EMPIRE) {
    name
  }
  jediHero: hero(episode: JEDI) {
    name
  } }
{
  "data": {
    "empireHero": {
      "name": "Luke Skywalker"
    },
    "jediHero": {
      "name": "R2-D2"
    } } }
  • empireHero:jediHero:는 알리아스를 의미한다.
  • 즉, 같은 hero이지만 결과 json을 보면 key 값이 지정한 알리아스로 되어 있다.
    • SQL의 as를 떠올리게 하는 기능이다.

fragments

https://graphql.org/learn/queries/#fragments

중복 필드를 fragment로 묶어 표현하는 것도 가능하다.

쿼리 결과
{
  leftComparison: hero(episode: EMPIRE) {
    ...comparisonFields
  }
  rightComparison: hero(episode: JEDI) {
    ...comparisonFields
  } }

fragment comparisonFields on Character {
  name
  friends { name }
}
{
  "data": {
    "leftComparison": {
      "name": "Luke Skywalker",
      "friends": [
        { "name": "Han Solo" },
        { "name": "Leia Organa" },
        { "name": "C-3PO" },
        { "name": "R2-D2" } ] },
    "rightComparison": {
      "name": "R2-D2",
      "friends": [
        { "name": "Luke Skywalker" },
        { "name": "Han Solo" },
        { "name": "Leia Organa" } ]
    } } }
  • fragment는 fragment 이름 on 타입 { 필드 } 형태로 정의한다.
  • 정의한 fragment는 query에서 ...프래그먼트이름으로 사용한다.
  • leftComparisonrightComparison...comparisonFields fragment를 사용하고 있다.
    • 따라서 둘 다 namefriends { name } 필드를 갖는다.

mutations

https://graphql.org/learn/queries/#mutations

다음과 같이 mutation을 정의할 수 있다.

mutation CreateReviewForEpisode($ep: Episode!, $review: ReviewInput!) {
  createReview(episode: $ep, review: $review) {
    stars
    commentary
  }
}

다음과 같은 json을 전송하면..

{
  "ep": "JEDI",
  "review": {
    "stars": 5,
    "commentary": "This is a great movie!"
  } }

업데이트 결과가 돌아온다.

{
  "data": {
    "createReview": {
      "stars": 5,
      "commentary": "This is a great movie!"
    } } }
  • ep는 업데이트 대상 조회용으로 사용되었고, review는 업데이트 내용으로 사용되었다.
  • 이 때 reviewinput object type으로 선언된 것이다.

함께 읽기

  • [[/REST-paper-summary]]

참고문헌

주석

  1. 웹 앱 API 개발을 위한 GraphQL. 3장. 69쪽. 

  2. 웹 앱 API 개발을 위한 GraphQL. 3장. 38쪽. 

  3. 웹 앱 API 개발을 위한 GraphQL. 4장. 71쪽. 

  4. 웹 앱 API 개발을 위한 GraphQL. 4장. 71~76쪽. 

  5. 웹 앱 API 개발을 위한 GraphQL. 4장. 84~89쪽. 

  6. 웹 앱 API 개발을 위한 GraphQL. 4장. 90쪽.  2

  7. 웹 앱 API 개발을 위한 GraphQL. 4장. 89쪽. 

  8. 웹 앱 API 개발을 위한 GraphQL. 4장. 92쪽. 

  9. 웹 앱 API 개발을 위한 GraphQL. 4장. 97쪽. 

  10. type Query {..}는 30042~30537번 라인. repository(..): Repository는 30288~30303번 라인. 

  11. Repository {..}는 34616~36013번 라인. issues(..) 는 35175~35215 

  12. addReaction(..)는 18003~18008번 라인. 

  13. input AddReactionInput {..}는 659~690번 라인. 

  14. type AddReactionPayload {..}는 692~710번 라인.