首页 > 解决方案 > 记录 AWS API Gateway API

问题描述

我正在尝试为我开发的 API 网关 API 生成文档。我去方法。点击我的方法。它向我展示了一个有四个图块的屏幕。其中之一是方法响应。我转到该部分并单击右上角的书本图标。添加描述并继续

API 网关屏幕

问题是,当我使用 200 响应正文旁边的书/文档图标添加响应时。它没有反映在最终导出的文档 JSON 中。从屏幕截图中可以看出,我还添加了响应模型。我在生成文档后得到的响应只包含一个空对象。

 "paths": {
    "/sls": {
      "get": {
        "description": "The ***** api health service endpoint",
        "responses": {}
      }
    },

我在生成文档方面是否遗漏了一些东西。我尝试添加响应对象,例如 open api https://swagger.io/specification/中的路径项,但不幸的是,这对我不起作用。任何帮助/方向将不胜感激。

标签: amazon-web-servicesswaggeraws-api-gatewayapi-gatewaydocumentation-generation

解决方案


推荐阅读