Yanonoblog!

こつこつと

GraphQL - オペレーションと変数の使用

はじめに

GraphQLのドキュメントを読んでまとめていきます。

ところどころ気になった部分を調べて補足したり解釈を入れています。

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

オペレーション名の利用

GraphQLクエリにはオペレーション名を付けることができるためコードの明確性が向上します。

サンプルクエリ

query PlantDetails {
  plant {
    type
    environment {
      climate
    }
  }
}

オペレーションの種類

オペレーションの種類は、querymutation、またはsubscriptionのいずれかであり、行おうとしている操作の種類を示します。

変数の使用

ほとんどのアプリケーションでは、フィールドへの引数は動的です。GraphQLには、クエリから動的な値を取り出し、別の辞書として渡すための方法があります。

サンプルクエリ

query PlantDetailsByClimate($climate: ClimateType) {
  plant(climate: $climate) {
    type
    environment {
      climate
    }
  }
}

サンプル変数

{
  "climate": "TROPICAL"
}

変数の定義

変数の定義は、クエリ内の($climate: ClimateType)のような部分で、型付き言語の関数の引数の定義のように動作します。

デフォルト変数

変数にはデフォルト値も割り当てることができます。

サンプルクエリ

query PlantDetailsByClimate($climate: ClimateType = DESERT) {
  plant(climate: $climate) {
    type
    environment {
      climate
    }
  }
}

おしまい

コメント

本記事の内容は以上になります!