🎃

GraphQLクエリ言語（GraphQLスキーマ定義言語）

2023/08/12に公開

概要

以下の記事でGraphQLサーバを立てるにあたり、GraphQLクエリ言語についてまとめる。GraphQL初心者向けドキュメント。

GraphQLクエリ言語(GraphQLスキーマ定義言語)は GraphQL 型システムで利用するスキーマを定義するための言語。

GraphQL クエリ言語は基本的にオブジェクトのフィールドを選択するもの。
まず以下のスキーマを定義（①）し、スキーマのフィールドを選択（②）することでレスポンス③を得る。

① スキーマ(サーバ側で定義)

{
  "data": {
    "hero": {
      "name": "R2-D2",
      "appearsIn": [
        "NEWHOPE",
        "EMPIRE",
        "JEDI"
      ]
    }
  }
}

② リクエスト(クライアント → サーバ)

{
  hero {
    name
    appearsIn
  }
}

③ レスポンス(サーバ → クライアント)

{
  "data": {
    "hero": {
      "name": "R2-D2",
      "appearsIn": [
        "NEWHOPE",
        "EMPIRE",
        "JEDI"
      ]
    }
  }
}

以下のような特徴を持つ。

引数を渡すクエリ

{
  human(id: "1000") {
    name
    height(unit: FOOT)
  }
}

レスポンス(id=1000の人のデータのみを、身長をフィート表記にして返している)

{
  "data": {
    "human": {
      "name": "Luke Skywalker",
      "height": 5.6430448
    }
  }
}