Invokora 帮助中心
操作指南

配置 OpenAPI、上游和认证

为真实 API 配置上游地址、认证字段、路由和必要的请求或响应转换。

本页目录

导入与更新接口文档

  1. 在产品编辑页打开“接口”,上传 JSON/YAML,粘贴文档,或填写“OpenAPI HTTPS URL”后点击“从 URL 导入”。
  2. 使用不超过 5 MiB 的自包含 OpenAPI 3.0.x 或 3.1.x 文档;内部 $ref 可以使用,外部文件和 URL 引用需先合并到文档。
  3. 保存后核对已解析的 HTTP 方法和路径,再到“定价”配置各套餐的端点权限。
OpenAPI 文档编辑区已粘贴描述 GET /health 的 YAML,顶部提供文件和 URL 导入入口。
上传 JSON/YAML 或粘贴 OpenAPI 文档;示例的 GET /health 可在保存后解析。截图使用本地演示数据。 查看大图(在新标签页打开)

设置上游组与路由

  1. 在“上游组”填写组 ID 和公开 HTTPS 地址,每行一个。选定“默认上游组”,让没有特殊规则的请求有明确去向。
  2. 需要分流时点击“添加路由”,选择适用端点、适用套餐和目标上游组。
  3. 优先级依次是端点与套餐组合、端点、套餐、默认。多地址组内轮询,每次只尝试一个上游。
上游组 default 填写示例 HTTPS 地址,并被选为默认上游组。
在“接口”填写自己的 HTTPS 上游并选择默认组。截图为本地演示数据,example.com 需换成你的地址。 查看大图(在新标签页打开)

设置上游认证

  1. 在“上游认证与可信上下文”点击“添加注入字段”,选择 Header 或 Query、字段名称和值来源。
  2. 例如你的上游需要 Authorization: Bearer …:选择 Header,字段名称填 Authorization,值来源选“固定密钥”,密钥值填完整的 Bearer 前缀和真实 token。
  3. 需要传入买家 ID 或套餐代码时,选择“Invokora 可信上下文”及对应字段;使用作用范围限定适用的端点和套餐。
  4. 保存后密钥隐藏;之后留空会保留已有值。不要把上游密钥写入商品说明或公开 OpenAPI 示例。

需要适配接口时再添加转换

更多设置
  1. 在“请求与响应转换”点击“添加转换”,选择请求或响应阶段、目标类型和添加、删除、复制或重命名操作。
  2. 限定适用端点、套餐和必要的 Content-Type;JSON 字段使用 /path 形式的 JSON Pointer。
  3. 保存后重新测试受影响端点和套餐,检查实际发出的请求及返回结果是否仍符合公开文档。

保存、测试并发布修改

  1. 核对“Origin 超时(秒)”为 1–180,“最大请求/响应体(字节)”不超过 50 MB,然后保存。
  2. 按“测试套餐”逐一选择启用的套餐,测试其授权端点。每个有效上游组中的全部地址都必须有通过的测试。
  3. 检查预览并发布;仅保存草稿不会更新公开商品。
更新或下架 API 产品