如何在与AWS API网关兼容的OpenAPI 3.0. x中声明可空属性

Question

我们一直在使用OpenAPI 3.0。x规范，它添加了声明可为null的属性的特性。

当我将此OpenAPI导入AWS API网关时，相应的模型不支持此可为空设置。

有没有办法在OpenAPI 3.0中声明可为null的属性。那么AWS API网关是否也使用此设置识别和配置基础模型？

示例OpenAPI规范

openapi: "3.0.2"
info:
  title: Test
  description: |
    API
  version: "0.1.0"
  license:
    name: Private
    url: https://fillme.one/license
servers:
  - url: /api/v1
paths:
  /accounts:
    post:
      operationId: repa
      responses:
        200:
          description: test
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                date:
                  type: string
                  format: date-time
                  nullable: true
              required:
                - date

生成模型的结果JSON模式文档

{
  "required" : [ "date" ],
  "type" : "object",
  "properties" : {
    "date" : {
      "type" : "string",
      "format" : "date-time"
    }
  }
}

很明显，类型应该是[“string”，null]的并集，但AWS API网关忽略了OpenAPI规范。

有什么帮助吗？

Answer 1

AWS API网关需要JSON模式格式的模型，而不是OpenAPI模式格式的模型。以下是文档中的相关注释（重点是我的）：

API Gateway支持大多数OpenAPI 2.0规范和OpenAPI 3.0规范，但以下例外：

• API网关模型是使用JSON模式草案4定义的，而不是OpenAPI使用的JSON模式

这意味着AWS API网关需要type：[string，'null']而不是type： stringnullable： true。

但是，type：[string，'null']在OpenAPI 3.0中不是有效的语法（但在OAS 3.1中有效）。您可以做的是在将现有的OpenAPI文件导入AWS API Gateway之前对其进行预处理，并将可空类型定义更改为AWS期望的格式/语法。您可以尝试使用openapi-Schema-to-json-Schema等工具。