apollo-federation

Apollo Federation スキーマの作成

Apollo Federation を使用すると、複数の GraphQL API（サブグラフ）を統合されたスーパーグラフに合成できます。

Federation 2 のスキーマ設定

すべての Federation 2 サブグラフは、@link を使用してオプトインする必要があります。

extend schema
  @link(url: "https://specs.apollo.dev/federation/v2.12",
        import: ["@key", "@shareable", "@external", "@requires", "@provides"])

サブグラフで使用するディレクティブのみをインポートしてください。表示されているバージョン（v2.12）は例示用です。コピーしてそのまま使う前に、現在サポートされているバージョンを Federation の変更履歴で確認してください。

サブグラフの @link バージョンは下限であり、合成に使われるバージョンではありません。詳しくは Federation のバージョンを参照してください。

コアディレクティブのクイックリファレンス

ディレクティブ	用途	例
@key	一意のキーを持つエンティティを定義する	type Product @key(fields: "id")
@shareable	複数のサブグラフでフィールドを解決できるようにする	type Position @shareable { x: Int! }
@external	別のサブグラフのフィールドを参照する	weight: Int @external
@requires	外部フィールドに依存する計算フィールド	shippingCost: Int @requires(fields: "weight")
@provides	外部フィールドを条件付きで解決する	@provides(fields: "name")
@override	フィールドをこのサブグラフに移行する	@override(from: "Products")
@inaccessible	API スキーマから非表示にする	internalId: ID! @inaccessible
@interfaceObject	エンティティインターフェースにフィールドを追加する	type Media @interfaceObject

リファレンスファイル

トピックごとの詳細なドキュメントです。

• ディレクティブ - すべての Federation ディレクティブの構文、例、ルール
• スキーマパターン - 複数サブグラフのパターンとレシピ
• 合成 - 合成ルール、エラーコード、デバッグ

主なパターン

エンティティの定義

type Product @key(fields: "id") {
  id: ID!
  name: String!
  price: Int
}

サブグラフ間でのエンティティへの寄与

# Products subgraph
type Product @key(fields: "id") {
  id: ID!
  name: String!
  price: Int
}

# Reviews subgraph
type Product @key(fields: "id") {
  id: ID!
  reviews: [Review!]!
  averageRating: Float
}

@requires を使った計算フィールド

type Product @key(fields: "id") {
  id: ID!
  size: Int @external
  weight: Int @external
  shippingEstimate: String @requires(fields: "size weight")
}

@shareable を使った値型

type Money @shareable {
  amount: Int!
  currency: String!
}

エンティティのスタブ（寄与せずに参照）

type Product @key(fields: "id", resolvable: false) {
  id: ID!
}

基本ルール

• 必ず @link ディレクティブを使用した Federation 2.x 構文を使ってください
• 必ずサブグラフで使用するディレクティブのみをインポートしてください
• そのフィールドに対してすべてのサブグラフが同一の値を返すことを確認せずに、@shareable を使用しないでください
• 単純なエンティティ識別には、単一の ID フィールドを持つ @key を優先してください
• ローカルで合成を検証するには、rover supergraph compose を使用してください
• 本番スーパーグラフに対して検証するには、rover subgraph check を使用してください