跳转到内容
搜索文档

API 路由

最后更新 查看 MarkdownAgent 设置

API Shield 路由允许您公开单个外部 API,并将请求路由到不同的后端服务,即使这些服务使用与您的区域不同的路径或主机名。

过程

在创建路由之前,您必须通过既定方法将源端点添加到端点管理中,包括上传架构、通过 API 发现手动添加

要创建路由,您需要源端点的操作 ID。要在仪表板中查找操作 ID,请执行以下操作:

  1. 在 Cloudflare 仪表板中,前往 Web assets(Web 资产) 页面。

    Go to Web assets ↗
  2. 过滤端点以找到您的 源端点

  3. 展开源端点的行并注意 operation ID(操作 ID) 字段。

  4. 选择复制图标将操作 ID 复制到您的剪贴板。

  1. 登录到 Cloudflare 仪表板,然后选择您的账户和域。
  2. 选择 Security(安全性) > API Shield
  3. 过滤端点以找到您的 源端点
  4. 展开源端点的行并注意 operation ID(操作 ID) 字段。
  5. 选择复制图标将操作 ID 复制到您的剪贴板。

在将您的源端点添加到端点管理之后,请使用以下步骤在任何给定的操作 ID 上创建并验证路由:

创建路由

  1. 在 Cloudflare 仪表板中,前往 Web assets(Web 资产) 页面。

    Go to Web assets ↗
  2. 端点 中,选择一个现有端点并展开其详细信息。

  3. Routing(路由) 下,选择 Create route(创建路由)

  4. 输入要将您的端点路由到的目标 URL 或 IP 地址。

  5. 选择 Deploy route(部署路由)

  1. 登录到 Cloudflare 仪表板,然后选择您的账户和域。
  2. 前往 Security(安全性) > API Shield
  3. Endpoint management(端点管理) 中,选择一个现有端点并展开其详细信息。
  4. Routing(路由) 下,选择 Create route(创建路由)
  5. 输入要将您的端点路由到的目标 URL 或 IP 地址。
  6. 选择 Deploy route(部署路由)

您还可以通过在现有路由上选择 Edit route(编辑路由) 来编辑或删除路由。

测试路由

在向源端点发送请求后,您应该会看到后端服务的内容,就像您直接调用目标端点一样。

如果 API Shield 返回意外结果,请检查您的源端点主机、方法和路径,并验证路由以确保目标端点值正确。

可用性

API Shield 路由目前处于公开测试阶段,仅适用于订阅了 API Shield 的企业版客户。未购买 API Shield 的企业版客户可以在 Cloudflare 仪表板中预览 作为非合同服务的 API Shield,或通过联系您的账户团队来进行预览。

限制

如果路由位于同一区域,则目标端点不能路由到 Worker。

您不能更改请求的方法。例如,GET 源端点将始终向目标端点发送 GET 请求。

您必须在目标端点中使用源端点中出现的所有变量。例如,不允许将 /api/{var1}/users/{var2} 路由到 /api/users/{var2},这将导致错误,因为 {var1} 存在于源端点中,但不存在于目标端点中。

这篇文档对您有帮助吗?