コンテンツへスキップ
uencoder

GraphQL Schema

GraphQL スキーマ(GraphQL Schema)は SDL(Schema Definition Language)で型・クエリ・ミューテーション・サブスクリプションを定義する。GraphQL API の契約である。

目的

GraphQL API に対して強く型付けされた契約を定義し、クライアントが利用可能なデータと操作を知れるようにして、自動検証とコード生成を可能にする。

メカニズム

SDL は type/enum/input/interface/union/scalar 定義を提供し、type Query/Mutation/Subscription がエントリポイントとなる。すべてのフィールドは戻り値型と引数を、オプションでデフォルト値とディレクティブとともに宣言する。

ユースケース

  • GraphQL API の型契約
  • 自動コード生成
  • API ドキュメント

関連ツール

References