GraphQL スキーマ

スキーマは、データの編成と構造化の方法を記述します。 GraphQL サーバーは、スキーマを使用してデータをグラフとして記述します。このスキーマは、バックエンド データ ストアから入力されるフィールドを持つ型の階層を定義します。 スキーマは、クライアントがデータ グラフに対してどのクエリを実行できるかも正確に指定します。

使用可能なデータ型は、GraphQL スキーマからわかります。 確認する必要がある場合は、GraphQL で __schema field をクエリすることができます。 この方法で、スキーマと型がわかります。

クエリのルート型では __schema field が常に使用できます。

スキーマを表示するには、Preview API または Delivery API のいずれかの IDE で次のコマンドを実行します。

{
  __schema {
    types {
      name
    }
  }
}

GraphQL の型は、Content Hub のエンティティが GraphQL でどのようにマップされるかを示します。 次の表に、Content Hub と GraphQL の型の例を示します。

ヒント Content Hub のエンティティ定義に対応する GraphQL の型を見つけるには、"." を "_" に置き換えます。

CMP コンテンツ タイプのエンティティ用に作成された仮想型と、リスト型もあります。

スカラー型は、人気のあるプログラミング言語のプリミティブ型に似ています。 この型は常に具体的なデータに解決されます。

GraphQL のデフォルトのスカラー型は次のとおりです。

GraphQL には、次のカスタム スカラー型が含まれています。

GraphQL スキーマで定義する型のほとんどは、オブジェクト型です。 オブジェクト型にはフィールドのコレクションが含まれ、各フィールドはスカラー型または別のオブジェクト型のいずれかになります。

REST ベースの API を使用すると、さまざまなエンティティがさまざまなエンドポイントから返される可能性があります (たとえば、http://hostname/api/m.asset や http://hostname/api/m.content など)。 GraphQL の柔軟性により、クライアントは 1 回のリクエストで両方のリソースをクエリできます。

IDE docs は、スキーマと型の使用を定義します。