路由快速入门

在GraphOS和Apollo托管子图上运行路由器

你好！本教程将指导您安装路由器（GraphOS路由器或Apollo路由器核心）并在GraphOS和一些示例Apollo托管的子图上运行它。

本快速入门可帮助您运行一个自托管路由器实例。如果您使用Apollo GraphOS创建一个云超图，Apollo会为您配置和托管您超图的GraphOS路由器。

云超图适用于不需要在其自身基础设施中托管路由器的组织。

1. 下载并解压缩路由器二进制文件

ⓘ 注意

Apollo路由器核心源代码及其所有发行版本均根据弹性许可证v2.0 (ELv2)许可证提供。

下载选项

自动下载（Linux，OSX，WSL）

如果您有一个兼容bash的终端，您可以使用以下命令将Apollo路由器核心的最新版本直接下载到当前目录：

1
curl -sSL https://router.apollo.dev/download/nix/latest | sh

手动下载

前往Apollo Router Core的GitHub Releases页面👉GitHub Releases pageGitHub Releases page，下载最新版本。当前，以下版本的tar包可用：.tar.gz文件按以下列出：

Linux (x86_64)
Linux (aarch64)
macOS (苹果硅)
Windows (x86_64)

若您系统或架构的tar包不可用，您可以从源代码编译并运行路由器👉build and run the router from source，也可以在GitHub上提交一个issue👉open an issue on GitHub，请求添加新的架构。

下载后，在新项目目录中运行以下命令解压缩文件，将tar包的路径替换进去

1
tar -xf path/to/file.tar.gz --strip-components=1

如果省略--strip-components=1选项，则router可执行文件将安装在dist子目录中

运行二进制文件

现在可以从项目根目录使用以下命令运行：

1
./router

如果您这样做，您会得到类似以下输出

1
Apollo Router <version> // (c) Apollo Graph, Inc. // Licensed as ELv2 (https://go.apollo.dev/elv2)
2

3
⚠️  The Apollo Router requires a composed supergraph schema at startup. ⚠️
4

5
👉 DO ONE:
6

7
  * Pass a local schema file with the '--supergraph' option:
8

9
      $ ./router --supergraph <file_path>
10

11
  * Fetch a registered schema from GraphOS by setting
12
    these environment variables:
13

14
      $ APOLLO_KEY="..." APOLLO_GRAPH_REF="..." ./router
15

16
      For details, see the Apollo docs:
17
      https://apollo.graphql.net.cn/docs/federation/managed-federation/setup
18

19
🔬 TESTING THINGS OUT?
20

21
  1. Download an example supergraph schema with Apollo-hosted subgraphs:
22

23
    $ curl -L https://supergraph.demo.starstuff.dev/ > starstuff.graphql
24

25
  2. Run the router in development mode with the supergraph schema:
26

27
    $ ./router --dev --supergraph starstuff.graphql

这是因为在需要一个新的supergraph schema，但我们没有提供一个。让我们解决这个问题。

2. 下载示例 supergraph schema

在这个快速入门中，我们使用了示例Apollo-hosted子图以及一个由这些子图schema组成的示例supergraphschema。

从项目根目录运行以下命令

1
curl -sSL https://supergraph.demo.starstuff.dev/ > supergraph-schema.graphql

这会将一个含有以下内容的supergraph-schema.graphql文件保存下来：

supergraph-schema.graphql

1
schema
2
  @core(feature: "https://specs.apollo.dev/core/v0.1"),
3
  @core(feature: "https://specs.apollo.dev/join/v0.1")
4
{
5
  query: Query
6
  mutation: Mutation
7
}
8

9
directive @core(feature: String!) repeatable on SCHEMA
10

11
directive @join__field(graph: join__Graph, requires: join__FieldSet, provides: join__FieldSet) on FIELD_DEFINITION
12

13
directive @join__type(graph: join__Graph!, key: join__FieldSet) repeatable on OBJECT | INTERFACE
14

15
directive @join__owner(graph: join__Graph!) on OBJECT | INTERFACE
16

17
directive @join__graph(name: String!, url: String!) on ENUM_VALUE
18

19
scalar join__FieldSet
20

21
enum join__Graph {
22
  ACCOUNTS @join__graph(name: "accounts" url: "https://accounts.demo.starstuff.dev")
23
  INVENTORY @join__graph(name: "inventory" url: "https://inventory.demo.starstuff.dev")
24
  PRODUCTS @join__graph(name: "products" url: "https://products.demo.starstuff.dev")
25
  REVIEWS @join__graph(name: "reviews" url: "https://reviews.demo.starstuff.dev")
26
}
27

28
type Mutation {
29
  createProduct(name: String, upc: ID!): Product @join__field(graph: PRODUCTS)
30
  createReview(body: String, id: ID!, upc: ID!): Review @join__field(graph: REVIEWS)
31
}
32

33
type Product
34
  @join__owner(graph: PRODUCTS)
35
  @join__type(graph: PRODUCTS, key: "upc")
36
  @join__type(graph: INVENTORY, key: "upc")
37
  @join__type(graph: REVIEWS, key: "upc")
38
{
39
  inStock: Boolean @join__field(graph: INVENTORY)
40
  name: String @join__field(graph: PRODUCTS)
41
  price: Int @join__field(graph: PRODUCTS)
42
  reviews: [Review] @join__field(graph: REVIEWS)
43
  reviewsForAuthor(authorID: ID!): [Review] @join__field(graph: REVIEWS)
44
  shippingEstimate: Int @join__field(graph: INVENTORY, requires: "price weight")
45
  upc: String! @join__field(graph: PRODUCTS)
46
  weight: Int @join__field(graph: PRODUCTS)
47
}
48

49
type Query {
50
  me: User @join__field(graph: ACCOUNTS)
51
  topProducts(first: Int = 5): [Product] @join__field(graph: PRODUCTS)
52
}
53

54
type Review
55
  @join__owner(graph: REVIEWS)
56
  @join__type(graph: REVIEWS, key: "id")
57
{
58
  author: User @join__field(graph: REVIEWS, provides: "username")
59
  body: String @join__field(graph: REVIEWS)
60
  id: ID! @join__field(graph: REVIEWS)
61
  product: Product @join__field(graph: REVIEWS)
62
}
63

64
type User
65
  @join__owner(graph: ACCOUNTS)
66
  @join__type(graph: ACCOUNTS, key: "id")
67
  @join__type(graph: REVIEWS, key: "id")
68
{
69
  id: ID! @join__field(graph: ACCOUNTS)
70
  name: String @join__field(graph: ACCOUNTS)
71
  reviews: [Review] @join__field(graph: REVIEWS)
72
  username: String @join__field(graph: ACCOUNTS)
73
}

这个文件是router与我们的subgraphs通信所需的全部内容！

3. 以默认配置在开发模式下运行router

现在，从你的项目根目录运行以下命令

1
./router --dev --supergraph supergraph-schema.graphql

控制台输出应如下所示

1
2022-06-29T22:23:24.266542Z  INFO apollo_router::executable: Apollo Router v0.9.5 // (c) Apollo Graph, Inc. // Licensed as ELv2 (https://go.apollo.dev/elv2)
2
2022-06-29T22:23:24.488286Z  INFO apollo_router::router: starting Apollo Router
3
2022-06-29T22:23:25.774334Z  INFO apollo_router::axum_http_server_factory: GraphQL endpoint exposed at http://127.0.0.1:4000/ 🚀

这样就完成了！使用router时加上--dev标志将启用开发模式，暴露Apollo沙盒，以便你可以在router上运行查询。

⚠️ 注意

不要在非开发环境中使用--dev标志。它会放宽某些默认配置选项，以提供改进的本地开发体验（例如，它将客户端可见的子图错误消息暴露出来）。

了解更多关于开发模式默认设置的信息。

访问 http://127.0.0.1:4000 打开Apollo沙盒，检查您的整个supergraph，并运行您的第一个查询！

下一步

现在您已经知道了如何使用supergraph schema运行router，您可以：

简介

从@apollo/gateway迁移