概要
以下は、GraphQL APIを使い始めるためのクイックリンクです。
GraphQLについて
GraphQLデータクエリ言語は、
-
仕様です。この仕様は、APIサーバー上のスキーマの正当性を決定します。 スキーマは、クライアントの呼び出しの正当性を決定します。
-
強く型付けされています。スキーマは、APIの型システ� とすべてのオブジェクトの関係を定義します。
-
イントロスペクティブです。クライアントは、スキーマに関する詳細を求めるためにスキーマに対してクエリを行えます。
-
階層型です。GraphQLの呼び出しの形は、返されるJSONデータの型を反� します。 入れ子になったフィールドによって、1回のラウンドトリップで指定したデータ� けをクエリで返してもらうことができます。
-
アプリケーション層です。GraphQLはストレージモデルやデータベースクエリ言語ではありません。 グラフはスキーマで定義されたグラフ構� を指し、ノードはオブジェクトを、エッジはオブジェクト間の関係を定義します。 APIは、データがどのように保存されているかに関係なく、スキーマ定義に従ってアプリケーションデータをトラバースして返します。
GitHubがGraphQLを使う理由
GitHubは、インテグレーターにとって大きな柔軟性を提供してくれることから、GraphQLを選択しました。 ほしいデータ、そしてほしいデータ� けを正確に定義できるのは、旧来のREST APIエンドポイントよりも強力な利点です。 GraphQLを使えば、指定したデータをフェッチするための複数のRESTのリクエストを単一の呼び出しで置き換えられます。
GitHubがGraphQLに投資した理由の詳細については、オリジナルのアナウンスのblogポストを参照してく� さい。
GraphQLのスキーマ参照について
サイドバー内のドキュメントは、GitHubのGraphQLスキーマから生成されます。 すべての呼び出しは、このスキーマに対して検証され、実行されます。 以下のドキュメントを使って、呼び出せるデータを見つけてく� さい。
同じ内容には、Explorer Docsサイドバーからもアクセスできます。 GraphQL APIの呼び出しをうまく行うためには、ドキュメントとスキーマ検証の両方に依存しなければならないことがあります。
認証やレート制限の詳細など その他の情� �についてはガイドを参照してく� さい。
サポートのリクエスト
For questions, bug reports, and discussions about GitHub Apps, OAuth App, and API development, explore the GitHub API Development and Support Forum. このフォーラ� はGitHubのスタッフによって進行及び管理されていますが、フォーラ� にポストされた疑問に対してGitHubのスタッフからの返答があることは保証されていません。
以下の� �合は、連絡フォー� を使ってGitHub Supportに直接連絡することを検討してく� さい。
- GitHub Enterprise Serverのスタッフからの反応を確実に得たい� �合
- センシティブなデータやプライベートな懸念事� �に関わるサポートリクエスト
- 機能リクエスト
- GitHub Enterprise Serverの製品に関するフィードバック