よくある質問 (FAQ)

なぜGraphQLを使うべきですか？#

ユースケースによって異なりますが、一般的にGraphQLにはいくつかの重要な機能があります。例えば、GraphQLを使用すると、

• 複数のUIコンポーネントからデータを統合できます。
• データの表現を、馴染みやすく自然なもの（グラフ）にできます。
• すべてのデータが静的に型付けされ、これらの型はスキーマがサポートするクエリを決定します。
• 破壊的変更の必要性を減らすことができますが、必要に応じて非推奨化のための組み込みメカニズムを使用することもできます。
• GUI、エディタ統合、コード生成、リンティング、分析など、強力なツールエコシステムにアクセスできます。

ホームページでは、GraphQLを使用する理由をさらに詳しく説明しています。

アプリケーション全体を書き直さなくても、GraphQLを試すことができます。例えば、既存のREST呼び出しをラップする単一のHTTPリクエストから始めることができます。GraphQLスキーマとビジネスドメインモデルは徐々に拡張できます。最初は1つのユースケースに焦点を当て、そのために必要なスキーマの部分だけを構築することをお勧めします。

GraphQLはRESTに取って代わるものですか？#

いいえ、必ずしもそうではありません。どちらもAPIを処理し、ビジネスの観点から同様の目的を果たすことができます。GraphQLはRESTの代替手段として考えられることがよくありますが、決定的な置き換えではありません。

GraphQLとRESTは、実際にはスタック内で共存できます。例えば、GraphQLサーバーの背後でREST APIを抽象化することができます。これは、ルートレゾルバーを使用してRESTエンドポイントをGraphQLエンドポイントに隠すことで実現できます。

GraphQLとRESTの比較に関する意見については、How To GraphQLをご覧ください。

GraphQLはSQLのようなデータベース言語ですか？#

いいえ、これはよくある誤解です。

GraphQLは、通常、リモートクライアントサーバー通信に使用される仕様です。SQLとは異なり、GraphQLはデータの取得と変更に使用されるデータソースに依存しません。データへのアクセスと操作は、レゾルバーと呼ばれる任意の関数を使用して実行されます。GraphQLはこれらのレゾルバー関数からデータを調整および集約し、結果をクライアントに返します。一般的に、これらのレゾルバー関数は、さまざまな基盤となるデータソースとの通信を担当するビジネスロジックレイヤーに委任する必要があります。これらのデータソースは、リモートAPI、データベース、ローカルキャッシュ、その他プログラミング言語でアクセスできるほぼすべてのものになります。

GraphQLをデータベースと連携させる方法の詳細については、レゾルバーに関するドキュメントをご覧ください。

GraphQLをどのように学習できますか？#

GraphQLの学習に役立つ多くのリソースが利用可能です。このウェブサイトもその一つです。ドキュメントには、重要なGraphQLの概念とその仕組みを説明する記事が掲載されています。コミュニティページには、参照できるリソースや参加できるグループがたくさんあります。

より実践的なガイドについては、How to GraphQLのフルスタックチュートリアルウェブサイトをご覧ください。edXでは無料のオンラインコースExploring GraphQL: A Query Language for APIsも提供しています。

学習を始める前に、APIとは何か、クライアントとサーバー間の通信が一般的にどのように機能するのかを理解しておきましょう。

GraphQLはReactまたはJavaScript開発者だけのためのものでしょうか？#

いいえ、そうではありません。GraphQLは仕様であり、あらゆる言語で実装できます。コードページには、さまざまなプログラミング言語で利用できるライブラリの長いリストがあります。

しかし、そう考えるのも無理はありません。GraphQLはReactカンファレンスで発表され、GraphQL.jsは現在最も広く使用されている実装の1つです。これが混乱を招く可能性があることを理解しているので、ドキュメントの改善と、JavaScriptで記述されていないコードサンプルの追加に取り組んでいます。

GraphQLはフロントエンドですか、バックエンドですか？#

両方です。GraphQLは、クライアントとサーバー間で情報を交換する方法を指定します。これには、サーバーが利用可能なデータと操作を示す方法、クライアントがリクエストをフォーマットする方法、サーバーがこれらのクエリを実行する方法、クライアントがレスポンスとして受信するものが含まれます。

GraphQLはHTTPを使用しますか？#

はい、GraphQLは通常HTTP経由で提供されます。これは、HTTPプロトコルが業界で広く普及しているためです。しかし、単一のHTTPリクエストを作成することでGraphQLを試すことができるため、役立ちます。HTTP経由で動作するGraphQLサーバーの設定に関するガイドラインは、HTTP経由での提供ドキュメントに記載されています。

HTTPはクライアントサーバープロトコルの最も一般的な選択肢ですが、唯一の選択肢ではありません。GraphQLはトランスポートレイヤーに依存しません。そのため、例えば、リアルタイムデータを使用するために、HTTPではなくWebSocketsをGraphQLサブスクリプションに使用できます。

GraphQLは製品のパフォーマンスにどのように影響しますか？#

一般的なGraphQLバックエンドでは、各型のすべてのフィールドに、その値を解決するための集中型で単一目的の関数が用意されています。また、クライアントでのデータバッチング処理を試みる代わりに、GraphQLはそのロジックをサーバーに移動します。その結果、いくつかの固有のパフォーマンス上の利点があります。オーバーフェッチを最小限に抑え、サーバーへのラウンドトリップを減らすことがその2つです。

GraphQLの実装を構築する際には、その他のパフォーマンス要因も考慮する必要があります。例えば、GraphQLサービスが「チャッティ」になり、データベースから繰り返しデータを読み込む可能性があります。これは、一般的にバッチングテクニックを実装するか、DataLoaderのようなツールを利用することで解決されます。

GraphQLクライアントとは何ですか？また、なぜ使用するのでしょうか？#

GraphQLクライアントは、クエリ、ミューテーション、およびサブスクリプションをGraphQLサーバーに処理するのに役立ちます。GraphQL APIの基盤となる構造を使用して、特定のプロセスを自動化します。これには、バッチ処理、UI更新、ビルド時のスキーマ検証などがあります。

さまざまな言語のGraphQLクライアントのリストは、コードページにあります。それらの利点の詳細な説明は、How To GraphQLにあります。

ただし、GraphQLを使用するために特定のクライアントは必要ありません。通常のHTTPクライアントでGraphQLの結果を発行することから始めることができます。その後、アプリケーションの複雑さが増すにつれて、GraphQLに最適化されたクライアントに切り替えることができます。

GraphQLはORMに取って代わるものですか？#

いいえ、GraphQLは通常、リモートクライアントサーバー通信に使用される仕様です。使用されるデータソースに依存しませんし、オブジェクトリレーショナルマッピングテクニックを実装しません。しかし、GraphQL用に特別に構築されたORMもあります。それらのいくつかは、コードページのサービスセクションに記載されています。

GraphQLはFacebookが所有していますか？#

いいえ、GraphQLはGraphQL Foundationによって管理されています。

つまり、この仕様はもともとFacebookで開発され、FacebookはGraphQL Foundationのメンバーです。一部のGitHubリポジトリのライセンスがまだFacebook Inc.の下に記載されていることに気付くかもしれません。それらを更新しており、GraphiQLやDataLoaderなどの主要プロジェクトはすでに新しい著作権「Copyright (c) 2020 GraphQL Contributors.」に変更しています。

GraphQL の開発元は？#

多くの人々です。！GraphQL の仕様書と関連プロジェクト全てはオープンソースなので、誰でも貢献できます。とはいえ、リポジトリの背後には構造が存在します。これはコミュニティ内の衝突を解決し、技術的な意思決定を導くために存在します。

GraphQL Foundationが GraphQL の大部分の監督を行っています。それは数十の異なる企業の代表者で構成されています。

また、GraphQL Foundation によって管理される月次のバーチャルGraphQLワーキンググループ (WG) 会議もあります。これらの会議は、一般的に使用されている GraphQL ライブラリやツールのメンテナンス担当者、そして GraphQL コミュニティへの重要な貢献者を一堂に会わせることを目的としています。WG 会議は完全に公開されています。誰でも参加し、議題に項目を提案することができます。

2020年11月のWG会議では、GraphQL が今後、技術諮問委員会 (TSC) を持つことが発表されました。詳細については近日公開予定です。

分かりにくい場合はご心配なく - 多くのことが進行中です。より視覚的で高レベルの概要については、GraphQL Landscapeをご覧ください。

GraphQL Foundation とは何ですか？#

GraphQL Foundation は、GraphQL のガバナンスを提供する中立的な財団です。これには、オープンソースリポジトリのベンダーニュートラルな監視、資金調達、イベントなどが含まれます。Linux Foundationの下でホストされており、数十の異なる企業の代表者で構成されています。GraphQL コミュニティのための公平でオープンなホームであることが目的です。

foundation.graphql.org を訪問して、詳細を確認できます。

GraphQL はスケーラブルですか？#

はい、GraphQL はスケーラブルになるように設計されており、多くの企業で非常に高い負荷の下で本番環境で使用されています。

GraphQL には、役に立つ組み込みのパフォーマンス向上機能がいくつか用意されています。しかし、本番環境に導入したら、インスタンス間でのスケーリングとパフォーマンスの監視はあなたの責任になります。

GraphQL はオフライン使用をサポートしていますか？#

いいえ、少なくともネイティブではありません。しかし、オフラインファーストを構築できるGraphQL クライアントがあります。これらは、キャッシングやサービスワーカーなど、オフライン時にデータ操作を実行するように設計された機能を使用します。

各種言語の GraphQL クライアントのリストは、当社のコードページにあります。

GraphQL のセキュリティ上の懸念事項は何ですか？#

GraphQL に関連するセキュリティ上の懸念事項の大部分は、任意の API やサービスで一般的です。いくつかの例としては、SQL インジェクション、サービス拒否 (DoS) 攻撃、または欠陥のある認証を悪用する人がいます。しかし、GraphQL に固有の攻撃もあります。例えば、バッチ攻撃です。これらの攻撃は、GraphQL が単一のネットワーク呼び出しで複数のクエリ（または複数のオブジェクトインスタンスに対するリクエスト）をバッチ処理することを許可していることが原因で発生する可能性があります。

懸念事項にかかわらず、予防措置を講じることは重要です。GraphQL サーバーを保護するための方法はたくさんあります。タイムアウトの使用、クエリの最大深さの設定、完了に必要なサーバー時間に基づいてクエリの調整などは、すべて考えられるアプローチです。

一般的なセキュリティ上の懸念事項とその対処方法の概要については、How to GraphQL のセキュリティチュートリアルとOWASP の GraphQL チートシートをご覧ください。

GraphQL で承認を設定するにはどうすればよいですか？#

ビジネスロジックレイヤーで承認動作を適用することをお勧めします。そうすれば、承認の単一の真実の情報源を持つことができます。

より詳細な説明については、当社の承認ドキュメントを参照してください。

GraphQL で認証はどのように機能しますか？#

OAuthやJWTなどの一般的なパターンを使用して認証を実装できます。GraphQL の仕様内では、認証について特別なものは何もありません。

いくつかのGraphQL ライブラリには、認証のための特定のプロトコルも含まれています。ただし、パイプラインモデルを使用している場合は、GraphQL をすべての認証ミドルウェアの後に配置することをお勧めします。

GraphQL.jsを使用して API サーバーを構築する場合は、Express ミドルウェアを使用した認証の処理に関するドキュメントがあります。

GraphQL はマイクロサービスアーキテクチャの設計に適していますか？#

はい、可能です。マイクロサービスアーキテクチャに GraphQL を統合する場合は、クライアントが複数の GraphQL サービスと通信するのではなく、API ゲートウェイとして 1 つの GraphQL スキーマを使用することをお勧めします。このようにして、バックエンドをマイクロサービスに分割できますが、それでも単一の API からフロントエンドにすべてのデータを収集できます。

API ゲートウェイを作成するには多くの方法があります。GraphQL を使用することの利点は、キャッシング、リクエストのバジェット、クエリのスケジュールの計画などの機能を利用できることです。

GraphQL でのバージョン管理はどのように機能しますか？#

他の REST API と同様に、GraphQL サービスのバージョニングを妨げるものはありません。とはいえ、GraphQL は設計上、バージョン管理を回避します。

代わりに、GraphQL はスキーマを継続的に構築および進化させるためのツールを提供します。たとえば、GraphQL は明示的に要求されたデータのみを返します。これは、破壊的な変更を作成したり、既存のクエリの結果を膨らませたりすることなく、新しい機能（および関連するすべてのタイプとフィールド）を追加できることを意味します。

GraphQL でのバージョン管理のしくみについては、ベストプラクティスセクションで詳しく読むことができます。

GraphQL API をドキュメント化するにはどうすればよいですか？#

GraphQL の利点の 1 つは、本質的に自己ドキュメント化されていることです。GraphiQLなどのインタラクティブツールを使用すると、GraphQL API によって公開されているデータ（フィールド、タイプなど）を調べることができます。description フィールドを追加して、エンドポイントに関する補足的なメモを提供することもできます。この description フィールドは、文字列と Markdown をサポートしています。

多くの人にとって、これは十分な API リファレンスドキュメントを提供します。しかし、他の形式のドキュメントの必要性を減らすわけではありません。一般的な概念が特定のユースケースにどのように関連しているかを説明するガイドを作成する必要があるでしょう。

仕様書のリリースをフォローする最良の方法は？#

GraphQL 仕様書の最新のワーキングドラフトリリースは、spec.graphql.org/draftにあります。以前のエディションも、リリースタグに対応するパーマリンクで利用できます。

各リリースの背後にあるプロセス全体はオープンソースです。graphql-spec リポジトリのプルリクエストをフォローすることで、仕様書の提案を監視できます。また、さまざまな提案に関する過去の GraphQL ワーキンググループの議論をYouTubeで確認することもできます。

GraphQL の仕様にどのように貢献できますか？#

GraphQL はまだ進化しており、貢献は大歓迎です！仕様書（最新のワーキングドラフトを含む）はオープンソースです。コントリビューターガイドラインは GitHub で入手できます。

しかし、仕様書以外にも、GraphQL に関わる方法は他にもあります。このウェブサイトとドキュメントのコンテンツの更新などです。graphql-js、graphql-http、GraphiQL、またはGraphQL Foundationによって維持されているその他多くのプロジェクトの 1 つへの貢献などです。

GraphQL 仕様書のメンバーシップとは？#

GraphQL 仕様書と関連する参照実装は、Joint Development Foundation プロジェクト（Linux Foundation ファミリーの一部でもあります）。個人または企業の貢献者は、無料でドキュメントに署名し、貢献がプロジェクトのオープンソースライセンスに従うことに同意します。これは GraphQL Foundation のメンバーシップではないため、仕様書のメンバーは予算の使い道を決定しません。

GraphQL 仕様書のメンバーシップ文書に署名するには、任意のGitHub の GraphQL リポジトリに対して PR を開いてください。

あなたの組織が GraphQL を使用して恩恵を受けている場合は、会社を代表して PR を開き、GraphQL Foundation に参加することを検討してください。

サブスクリプションのドキュメントはどこにありますか？#

まだこのウェブサイトにはありませんが、現在作業中です。サブスクリプションに関するガイドの作成にご協力いただける場合は、お知らせください。

現時点では、仕様書にサブスクリプションの書き方と実行方法の詳細が含まれています。

GraphQLはReduxや他のステート管理ライブラリに取って代わるものですか？#

いいえ、GraphQLはステート管理ライブラリではありませんが、ステート管理ライブラリの必要性を軽減することができます。

Reduxのようなステート管理ライブラリの利点の1つは、APIレスポンスをアプリケーションが理解できる形式に変換できることです。GraphQLでは、リクエストするデータを制御でき、通常、グラフのデザインによってクライアントフレンドリーな形式で結果がフォーマットされます。そのため、この利点は既に組み込まれています。多くのクライアントライブラリもステートの管理に使用でき、キャッシュなどの機能が組み込まれています。それでもステート管理ライブラリを実装することを選択できますが、レスポンスデータのフォーマットに使用することは一般的には必要ありません。

GraphQL Foundationは何をしているのですか？#

Foundationの主な責任は、GraphQLコミュニティの持続可能性を最大限に高めるためのポリシー設定と予算配分です。メンバーは毎月開催される理事会に参加し、資金の配分方法を決定します。

メンバーになると、資金はどこに使われますか？#

GraphQL Foundationは、メンバーのサポートによってのみ資金提供されています。理事会は、会費をコミュニティの最大限の利益のために使用する年間予算を設定します。Foundationが会員シップを通じて集めた資金の分配方法は次のとおりです。

• 中立的な役割で活動しているコアコミュニティ開発者への助成金とスポンサーシップの提供。
• コアコミュニティITインフラストラクチャへの資金提供。
• FoundationとGraphQLプロジェクトエコシステムのための調整、財務、法的サポートプログラムへの資金提供。
• その他のコミュニティおよび開発者サポートプログラム。

GraphQL Foundationの予算は、コミュニティのニーズの変化に合わせて調整されます。

意思決定はどのように行われますか？#

他のLinux Foundationプロジェクトと同様に、理事会は投票によって意思決定を行います。すべての投票は平等であり、メンバーに特別な投票権や特権はありません。現在の憲章では、理事会のメンバー数を25名に制限しています。

誰がGraphQL Foundationに参加できますか？#

GraphQL Foundationの会員資格は、GraphQLエコシステムを支援したい企業に開放されています。GraphQL FoundationはLinux Foundationにホストされているため、メンバーはLinux Foundationにも参加する必要があります。

GraphQL開発に参加するためにFoundationに参加する必要がありますか？#

いいえ、Foundationの会員資格は技術開発コミュニティとは別です。GraphQL開発に参加する費用はかかりませんが、参加するには無料のGraphQL Specification会員契約に署名する必要があります。これら2つは別物です。

メンバーは、必須の資金を提供し、その使用方法に関する意思決定に参加するためにFoundationに参加します。開発者は、アイデア、コード、その他のコンテンツを提供するためにGraphQL Specificationに参加します。多くの企業は両方を行っています。

技術開発にはどのように参加できますか？#

ぜひご参加ください！始めるのに最適な場所は、毎月開催されるGraphQLワーキンググループです。議題に自分自身を追加するPRを開けば、参加できます。

それ以外では、他のプロジェクトに参加できます。

組織を設立したのは誰ですか？#

GraphQL Foundationは、Apollo、AWS、Butterfly Network、Dgraph Labs、Facebook、Gatsby、GraphZen、Hasura、IBM、Intuit、Neo4j、Novvum、Pipefy、Salsify、Solo.io、およびThicitによって設立されました。

現在メンバーになっているのは誰ですか？#

GraphQL Foundationの会員ページで、会員について詳しく知ることができます。

どのように参加できますか？#

会員申請フォームに記入することで、GraphQL FoundationとLinux Foundationのメンバーになることができます。