AWS API Gateway 的基于 URI 的版本控制

Question

我很难理解 AWS API Gateway 希望我如何组织我的 API，从而使版本控制变得简单。例如，假设我有一个简单的 API 用于从字典中获取单词，可选择通过查询参数过滤结果。我想在以下位置提供 v1：

https://<my-domain>/v1/names?starts-with=<value>

但是，我能获得 API 网关的最接近的位置是

https://<my-domain>/names/v1?starts-with=<value>

...这是相当落后的。

我在控制台中得到的是“名称 API”，它带有一个支持 GET 方法的“v1”资源。我也有我的自定义域设置将“名称”的基本路径映射到“名称 API”并阶段“测试”。基本路径必须是唯一的，因此放置“v1”只会在短期内获胜；一旦我创建了我的第二个 API（例如 Numbers API），它也会有一个 v1，我将无法创建第二个映射。

非常感谢任何和所有帮助，因为我现在没有想法。

Answer 1

不要将版本路径 (/v1) 创建为 API 中的资源。相反，只需调用 API“Names V1”并开始创建资源 (/names)。当您想要进行重大更改并创建 API 的新版本时，我们建议您创建一个名为“Names V2”的全新 API。再次，只需创建没有版本路径的资源。

要将这两个 API 结合在一起，您可以使用自定义域名。 API Gateway 中的自定义域名包括完全限定域名和基本路径。创建两个自定义域名：

• myapi.com/v1 -> 指向 Names V1 API 的 prod 阶段
• myapi.com/v2 -> 指向 Names V2 API 的 prod 阶段

通过这种方式，您可以在对 v2 进行更改的同时保持对 v1 的错误修复，并独立部署这两个 API。自定义域名会将它们组合在一起，使它们出现在同一个域下（myapi.com/v2/names）。

希望这会有所帮助。