GraphQLイントロスペクション

RESTに多くの利点をもたらすGraphQLの主な機能の1つがイントロスペクションです。GraphQLクエリ言語は強く型付けされています。このは強い型付けシステムによって、基本となるスキーマをクエリして理解することができます。

このスキーマはフロントエンドチームとバックエンドチームの間の契約として機能します。しかし、どのようにしてフロントエンド開発者はバックエンドスキーマがどのようなものかを把握するのでしょうか?また、どのようにして過剰な過不足を防ぐのでしょうか?これはイントロスペクションクエリによって可能になります。

イントロスペクションクエリ

GraphQLサーバーは、同じGraphQLクエリ言語を使って、スキーマに対するイントロスペクションをサポートします。

サーバーは、Query 操作タイプで以下のイントロスペクションクエリを公開します。

  • __schema
  • __type
  • __typename

イントロスペクションクエリは __ で始まることに注意してください。

コミュニティツール

イントロスペクションによって、コミュニティはGraphQLに関する素晴らしいツールを構築できます。GraphiQLGraphQLプレイグラウンドは、イントロスペクション機能を利用して、開発者にセルフドキュメントを提供して、APIを迅速に試します。

上記のツールは、__schema イントロスペクションクエリを使用して、スキーマのドキュメントを与えます。__schema クエリを試してさらに検討することで、さまざまな選択セット、フィールド、ディレクティブを確認できます。

Did you find this page helpful?
Start with GraphQL on Hasura for Free
  • ArrowBuild apps and APIs 10x faster
  • ArrowBuilt-in authorization and caching
  • Arrow8x more performant than hand-rolled APIs
Promo
footer illustration
Brand logo
© 2024 Hasura Inc. All rights reserved
Github
Titter
Discord
Facebook
Instagram
Youtube
Linkedin