Open API 中指定的文档不会从 AWS API Gateway 导出

Question

如前所述，我从JSON中的开放API规范开始。我使用云信息AWS:：ApiGateway:：RestApi资源将其导入API网关。

在此之后，我将API部署到一个阶段，最后，使用aws cli从此API阶段导出文档：

aws apigateway get-export \
    --parameters extensions='documentation' \
    --rest-api-id abc123 \
    --stage-name api \
    --export-type swagger \
    ./docs.json

my API中的开放式API参数示例:

{
    in: 'path',
    name: 'service',
    type: 'string',
    required: true,
    pattern: '^[-a-zA-Z0-9]+$',
    description: 'Name of the Service (document) to retrieve.'
}

当我用上面的aws-cli命令导出它时，我得到:

{
    "name" : "service",
    "in" : "path",
    "required" : true,
    "type" : "string"
}

说明和模式属性都已从文档导出中剥离，这是不好的，因为它们确实是此参数文档的主要部分。

还值得一提的是，如果我在AWS控制台（Swagger API网关扩展）中导出相同的API，我将获得与文档导出相同的参数定义。

还值得一提的是，这些集成都是基于Lambda代理的，如果这有所不同的话。

Answer 1

在 API Gateway 团队的帮助下，此问题已得到解决。

aws apigateway create-documentation-version \
    --rest-api-id abc123 \
    --documentation-version 1 \
    --stage-name api

完成此操作后，export命令将生成文档，而不是API定义，正如它以前所做的那样。

Answer 2

导入 Swagger 模板后，API 网关会将 API 定义及其文档拆分为两个单独的实体。这允许您独立修改和部署两者。

导出功能仅导出部署到阶段的任何内容。导入 Swagger 模板将导致导入 API 定义和文档部分。但是，看起来您只部署了 API 定义。您必须显式发布文档，然后才能在导出中提供该文档。

正如您所指出的，您还可以使用 CLI 发布新版本的文档：