将模式发布到 GraphOS

每次您对一个图谱's schema, you should publish those changes to Apollo GraphOS using the Rover CLI or the Platform API. Doing so ensures that Apollo always has an up-to-date understanding of your graph.

This page covers how to publish different kinds of schemas using the Rover CLI. Consult the Platform API reference to learn how to use the API for publication.

先决条件

1. 安装 Rover CLI.
2. 验证Rover 使用 GraphOS.

发布子图模式

GraphOS中的每个超级图都包含一个或多个子图。 这些是您的组织中由GraphQL驱动的独立微服务。

您需要分别将每个子图的架构发布到Apollo，使用rover subgraph publish:

rover subgraph publish --schema ./products.graphql --name products docs-example-graph@current --routing-url https://products.example.com

要将子图架构发布到Apollo：

1. 确定要发布的变体中的子图名称。您可以从GraphOS Studio的“子图”页面查看现有子图的名称。

2. 如果您是首次发布子图，还需要获取该路由URL。这是您的路由器与子图通信时使用的URL。

   • 如果GraphOS已经知道您的子图的路由URL，您无需提供此值，除非您要更改它。

3. 运行rover subgraph publish命令，并以以下方式之一提供您的'子图'模式的架构：

   Bash

   # Provide a local .graphql file path
   rover subgraph publish my-graph@my-variant --name locations --routing-url https://flyby-locations-sub.herokuapp.com/ --schema ./schema.graphql
   
   # Provide an introspection result via stdin
   rover subgraph introspect https://127.0.0.1:4000 | rover subgraph publish my-graph@my-variant --name locations --routing-url https://flyby-locations-sub.herokuapp.com/ --schema -

   复制

无论何时您发布子图模式，GraphOS都会尝试将您的子图模式架构的所有最新版本组合成单个超级图模式，供路由器使用：

如果这个组合成功，则路由器会更新结果。这使客户端能够查询任何新添加的字段，并防止它们查询任何已删除的字段。

您可以使用rover supergraph fetch命令手动获取您路由器的最新超级图模式，或者从GraphOS Studio中的超级图'架构' > SDL'页面获取。

发布单行图架构

1. 决定您如何向Rover提供您的服务器架构。您可以选择：

   • 在本地机器上保存的.gql或.graphql文件，或
   • 在运行的服务器上执行 introspection查询以获取模式

2. 运行rover graph publish命令，以以下方式之一提供您的架构：

   Bash

   # Provide a local .graphql file path
   rover graph publish my-graph@my-variant --schema ./schema.graphql
   
   # Provide an introspection result via stdin
   rover graph introspect https://127.0.0.1:4000 | rover graph publish my-graph@my-variant --schema -

   复制

   如上图所示，您提供给rover graph publish的-first位置参数是一个图形引用，这是一个字符串，用于指定GraphOS中某个特定图形的特定变体。

使用持续交付发布

要充分利用GraphOS，您应立即在生产架构中发布每个更新。因此，架构发布应成为您持续交付流程的一部分。

以下是在CircleCI中进行架构发布的示例持续交付配置

1
version: 2
2

3
jobs:
4
  build:
5
    docker:
6
      - image: circleci/node:8
7

8
    steps:
9
      - checkout
10

11
      - run: npm install
12

13
      - run:
14
          name: Install Rover
15
          command: |
16
            # Download and install Rover
17
            # This is pinned to a specific version for predictability in CI
18
            curl -sSL https://rover.apollo.dev/nix/v0.8.1 | sh
19

20
            # This allows the PATH changes to persist to the next `run` step
21
            echo 'export PATH=$HOME/.rover/bin:$PATH' >> $BASH_ENV
22

23
      # Start the GraphQL server.  If a different command is used to
24
      # start the server, use it in place of `npm start` here.
25
      - run:
26
          name: Starting server
27
          command: npm start
28
          background: true
29

30
      # make sure the server has enough time to start up before running
31
      # commands against it
32
      - run: sleep 5
33

34
      # When running on the 'main' branch, push the latest version
35
      # of the schema to GraphOS.
36
      - run: |
37
          if [ "${CIRCLE_BRANCH}" == "main" ]; then
38
            rover subgraph publish my-graph@my-variant \
39
              --schema ./schema.graphql \
40
              --name locations \
41
              --routing-url https://products.example.com
42
          fi