👀

サクっとGraphQLを学ぶ

2023/11/08に公開

GraphQL

REST API

Web API

tech

GraphQLはAPIのクエリ言語（データの問い合わせのための言語）です。

以下、基本的な三つの特徴を説明します。

３つの特徴

1. 必要なデータのみを取得できる

クライアントからリクエストを送信する際、レスポンスの形式を指定することができ、必要なデータのみを取得することができます。

例）ユーザー情報の中からuserIdとuserNameのみを取得するためのクエリ

リクエスト

query {
 users {
   userId
   userName
 }
}

レスポンス

{
  "data": {
    "users" : [
      { "userId": "1", "userName": "山田" },
      { "userId": "2", "userName": "田中" }
    ]
  }
}

2. 単一のエンドポイントで複数のリソースからデータを取得できる

RestAPIと比較して、一つのエンドポイントで複数のデータソースからデータの取得ができます。これにより、エンドポイントの管理が容易になります。複数のデータソースから一度でデータを取得できるため、データ量の多い場合などは通信効率の向上につながります。

以下リンクの図を参考にしています。

3. 型安全なデータ通信が可能になる

schema.graphqlというファイルを作成し、データの型を定義することでDB等のリソースとアプリ側での型の整合性をとることができる。

type User {		→　オブジェクト型		
       id: ID								
       name: String
       email: String						
}

type Query {		→　クエリ型（データ取得）
       me: User		→　User型のデータが返却される
}
 
type Mutation {		→　ミューテーション型（データ追加、更新、削除）
       createUser(id: 4, name: "Gnabry", friends: []){	 createUser(data: UserCreateInput!): User! 	
       →　dataを引数にして、User型のデータが返却される
}

"type Subscription {　→　（変更検知）　
       CreateUserInput: User  →　User型のデータが返却される
}