首页 > 解决方案 > 为非 JSON 内容类型创建 API Gateway 请求模型

问题描述

我已经构建了几个以 AWS API Gateway 为前端的 REST API 端点,它们接受并返回 JSON。我已经为这些端点定义了请求模型,以便可以将文档导出并导入到 Swagger 中进行测试。这一切都很好。

但是,一个端点接受自定义类型(它是文本,但在自定义结构中),而不是 JSON,我不知道如何为不是 JSON 的东西定义请求模型。该模型必须以JSON Schema编写,并且所有 AWS 文档示例仅演示 JSON 请求和响应(示例在末尾列出)。

例如以下请求模型:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "File Upload Request",
  "type": "object",
  "properties": {
    "filename": {
      "description": "Filename of the file being uploaded (with extension)",
      "type": "string"
    }
  }
}

在 Swagger 中呈现如下:

招摇请求正文

一个空的文本区域是可以接受的,但如果我可以添加示例输入会很棒。这可能吗?


AWS 文档中的示例:

标签: amazon-web-servicesswaggeraws-api-gateway

解决方案


推荐阅读