加入我们,从10月8日至10日在纽约市,学习关于 GraphQL 团结和 API 平台工程的最新技巧、趋势和新闻。加入2024年纽约市的 GraphQL 大会
文档
免费开始

云专业版入门

创建您的第一个云专业版路由器


当前处于邀请仅限模式预览. 如果您想请求访问或有任何问题或反馈,请随时联系我们

按照本实际操作指南创建一个新的 ,它使用 专有 。要了解有关专用云路由的详细信息,请参阅 云专用概述

先决条件

要完成此快速入门,您必须满足以下条件

  • 拥有 GraphOS Studio 帐户
  • 一个拥有 的组织联系我们 请求访问。
  • 一个或多个 Apollo 可以访问的 API。这意味着您必须:
    • 使您的 GraphQL API(s) 通过公开可访问的 URL 提供,例如,https://api.mycompany.com/subgraphA
    • 使您的 GraphQL API(s) 保持私密,但允许安全连接,例如,通过 VPC 网络交流

如果您有多个 ,每个都需要对 Apollo 保持开放。但是,您的 应仅通过您的云路由器公开访问。

注意

在超图中,每个 GraphQL API 被称为 子图。Apollo 称这些 GraphQL API 为 子图,即使您只连接一个 GraphQL API。

GraphOS 路由器不能作为另一个子图的超级图。

步骤 1. 创建新的图

要配置一个新的专用云路由器,您必须首先在GraphOS Studio中创建一个新的。为此,请从标签中点击创建新图。

Graphs tab in GraphOS Studio

步骤 2. 连接 API

  1. 接下来,将您的GraphQL API 连接到 Apollo。

    • 如果您的 API 网址是公开可访问的,请输入该 API 网址。此 URL 是客户端应用程序目前用于您的 API 的 URL。
    • 如果您的 API 不可公开访问且需要私有网络,您可以使用AWS VPC Lattice连接到它。选择我的端点不可公开访问以连接到 VPC。按照提示完成设置。
  2. 输入一个子图名称。该名称应反映您的 API 的数据或功能,并在您以后添加到超级图的其他 API 中保持唯一性。

    注意

    子图名称是不可变的。

  3. 选择要部署您的云路由器所在的后端提供商区域

  4. 可选,配置标头、密钥、CORS 规则或其他配置。您可以根据需要更新您的路由器配置

  5. 提供一个超级图名称ID

    • 超级图名称在 Studio 中显示,有助于您的团队区分不同的图。您可以在任何时间更改您图的名称。
    • ID 是不可变的,并且在 Apollo 中必须是唯一的。请确保它以字母开头,并只包含字母、数字和连字符。您将使用 ID 从各种工具中引用您的——例如,从
  6. 点击创建 GraphOS 路由器

为新提供您的新超级图可能需要几分钟时间。完成后,点击查询您的超级图以打开资源管理器并开始使用您的,或打开README以访问您的图的首页。

在进行下一步之前,添加您想连接的其他GraphQLAPI。从左侧导航中打开Subgraphs页面,然后点击添加子图

The 'Add a subgraph' button in the subgraphs page in GraphOS Studio

每次修改router配置或(包括添加子图)都会触发一个新的发布。每次都会自动部署新的云routerrouter实例以供您的supergraph使用。

注意

发布过程通常需要1-2分钟,但可能需要最长5分钟。在此过程中,Apollo将为新的配置资源,并在它们上线后进行交换。部署最小化API性能下降和停机时间。

第3步. 检查和配置您的云router

专用的有独立的UI用于管理和配置。从左侧导航中打开Cloud Router页面。此页面显示了您的云router的摘要,包括其API端点API详细信息

使用配置选项卡来管理您的云router的配置,包括秘钥Router配置YAML。有关更多信息,请参阅router文档

The Cloud Router page in GraphOS Studio

第4步. 测试和验证

要测试您的graph是否按预期工作,请通过从您的graphREADME页面点击在资源管理器中运行来运行一个示例查询。

启用子图错误报告如果您遇到问题。

为了进一步测试,您可以在开发或测试环境中为您的graph添加。为此,请转到设置>此图>变体并点击添加变体

Apollo建议运行负载测试以确定您运行graph所需的吞吐量容量

第5步. 上线

您的supergraph准备好开始接收客户端了!如果您有已连接到您的GraphQLAPI的现有客户端应用程序,您可以更新它们的GraphQL端点URL为您的router的URL。

类似地,任何新的客户端应用程序应使用您的router的URL。

注意

  • 对于所有基于浏览器的客户端,请确保它们的源被允许在您的router的CORS规则中。

  • 仅更新与您的GraphQL API正确实例通信的客户端。例如,如果您的API有预发布和生产实例,则仅更新与此supergraph使用的实例通信的客户端。

路由端点URL

您可以在云路由器页面中的找到您的端点URL。

A cloud router's endpoint displayed on the Cloud Router page in GraphOS Studio

注意

默认情况下,云路由器URL位于apollographos.net的子域名上。您可以通过设置自定义域名来最小化对客户端的改动。

下一步

祝贺!🎉 您已在GraphOS上构建了一个云supergraph。查看下一步文章,了解在supergraph上执行的一些最常见和最重要的操作,包括更新子图模式的schema和设置持续交付。

上一页
概述
下一页
吞吐量指南
速率文章速率Edit on GitHubEditForumsDiscord

©2024Apollo Graph Inc.,以Apollo GraphQL名义经营。

隐私政策

公司