联邦架构

了解不同类型的 GraphQL 模式

联合的超级图使用多种“类型”的 GraphQL 模式:

子图模式。每个子图都有一个独特的模式，表示它可以解析的 supergraph 中的哪些类型和字段。
- 这些是您团队唯一需要手动定义的模式。
超级图模式。这个模式结合了您所有 subgraph 模式中的所有类型和字段，以及一些联邦特定的信息，这告诉您的路由器哪些子图可以解析哪些字段。
- 该模式是执行以下操作的结果组合对您的子图模式集合。
API 模式。这个模式和超级图模式相似，但它省略了被认为是“机制”的联邦特定类型、字段和指令，这些不是您公共 API 的部分。
- 这是一个您的 router 向客户端公开的模式，客户端不需要了解图的内部实现细节。

让我们看看一个例子！

子图模式

以下是一个电子商务公司超级图中的三个子图的示例模式。每个子图都作为独立的GraphQL API实现：

用户

type Query {
  me: User
}

type User @key(fields: "id") {
  id: ID!
  username: String! @shareable
}

# (Subgraph schemas include
# this to opt in to
# Federation 2 features.)
extend schema
  @link(url: "https://specs.apollo.dev/federation/v2.3",
        import: ["@key", "@shareable"])

产品

type Query {
  topProducts(first: Int = 5): [Product]
}

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

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

type Review {
  body: String
  author: User @provides(fields: "username")
  product: Product
}

type User @key(fields: "id") {
  id: ID!
  username: String! @external
  reviews: [Review]
}

type Product @key(fields: "upc") {
  upc: String!
  reviews: [Review]
}

# (This subgraph uses additional
# federated directives)
extend schema
  @link(url: "https://specs.apollo.dev/federation/v2.3",
        import: ["@key", "@shareable", "@provides", "@external"])

如这些模式所示，多个子图可以为单个类型贡献独特的字段。例如，产品子图和评论子图都为Product类型

超级图模式

超级图模式是模式组合的输出。它具有以下用途：

它为你的路由器提供每个子图的名称和端点URL。
它包含了你所有子图中定义的所有类型和字段。
它告诉你的路由器哪些子图可以解析哪些GraphQL字段。

以下是与上述子图模式组合的超级图模式：

1
schema
2
  @link(url: "https://specs.apollo.dev/link/v1.0")
3
  @link(url: "https://specs.apollo.dev/join/v0.3", for: EXECUTION)
4
{
5
  query: Query
6
}
7

8
directive @join__enumValue(graph: join__Graph!) repeatable on ENUM_VALUE
9

10
directive @join__field(graph: join__Graph, requires: join__FieldSet, provides: join__FieldSet, type: String, external: Boolean, override: String, usedOverridden: Boolean) repeatable on FIELD_DEFINITION | INPUT_FIELD_DEFINITION
11

12
directive @join__graph(name: String!, url: String!) on ENUM_VALUE
13

14
directive @join__implements(graph: join__Graph!, interface: String!) repeatable on OBJECT | INTERFACE
15

16
directive @join__type(graph: join__Graph!, key: join__FieldSet, extension: Boolean! = false, resolvable: Boolean! = true, isInterfaceObject: Boolean! = false) repeatable on OBJECT | INTERFACE | UNION | ENUM | INPUT_OBJECT | SCALAR
17

18
directive @join__unionMember(graph: join__Graph!, member: String!) repeatable on UNION
19

20
directive @link(url: String, as: String, for: link__Purpose, import: [link__Import]) repeatable on SCHEMA
21

22
scalar join__FieldSet
23

24
enum join__Graph {
25
  PRODUCTS @join__graph(name: "products", url: "https://127.0.0.1:4002/graphql")
26
  REVIEWS @join__graph(name: "reviews", url: "https://127.0.0.1:4003/graphql")
27
  USERS @join__graph(name: "users", url: "https://127.0.0.1:4001/graphql")
28
}
29

30
scalar link__Import
31

32
enum link__Purpose {
33
  """
34
  `SECURITY` features provide metadata necessary to securely resolve fields.
35
  """
36
  SECURITY
37

38
  """
39
  `EXECUTION` features provide metadata necessary for operation execution.
40
  """
41
  EXECUTION
42
}
43

44
type Product
45
  @join__type(graph: PRODUCTS, key: "upc")
46
  @join__type(graph: REVIEWS, key: "upc")
47
{
48
  upc: String!
49
  name: String! @join__field(graph: PRODUCTS)
50
  price: Int @join__field(graph: PRODUCTS)
51
  reviews: [Review] @join__field(graph: REVIEWS)
52
}
53

54
type Query
55
  @join__type(graph: PRODUCTS)
56
  @join__type(graph: REVIEWS)
57
  @join__type(graph: USERS)
58
{
59
  topProducts(first: Int = 5): [Product] @join__field(graph: PRODUCTS)
60
  me: User @join__field(graph: USERS)
61
}
62

63
type Review
64
  @join__type(graph: REVIEWS)
65
{
66
  body: String
67
  author: User @join__field(graph: REVIEWS, provides: "username")
68
  product: Product
69
}
70

71
type User
72
  @join__type(graph: REVIEWS, key: "id")
73
  @join__type(graph: USERS, key: "id")
74
{
75
  id: ID!
76
  username: String! @join__field(graph: REVIEWS, external: true) @join__field(graph: USERS)
77
  reviews: [Review] @join__field(graph: REVIEWS)
78
}

如您所见，超级图模式包含了大量的联邦特定添加！这些添加仅供路由器使用，您永远不需要手动添加它们。

API模式

路由器使用其超级图模式生成一个API模式，将其作为您的实际GraphQL API公开。此模式清晰且逻辑地表示了您的子图模式的组合：

1
type Product {
2
  name: String!
3
  price: Int
4
  reviews: [Review]
5
  upc: String!
6
}
7

8
type Query {
9
  me: User
10
  topProducts(first: Int = 5): [Product]
11
}
12

13
type Review {
14
  author: User
15
  body: String
16
  product: Product
17
}
18

19
type User {
20
  id: ID!
21
  reviews: [Review]
22
  username: String!
23
}

与超级图模式不同，此模式隐藏了您的GraphQL API由多个不同的GraphQL API组成的实际情况。

JetBrains IDE 支持

组合