node.js - node.js 上 Swagger 的可空字段

Question

我花了很多时间试图找到在 Node.JS 中创建 swagger 文档的解决方案。主库是 swagger-node，您可以在其中创建一个 swagger yaml 文件，然后将 Controller 添加到其中。它会自动在您的应用中提供 swagger ui 文档，并针对您在 yaml 中指定的模型对请求和响应进行验证。

这很简洁，但是我有一个要求，我希望某些字段能够显式返回或接受 null 作为值，例如:

{ 
  id: 123,
  description: "string",
  date_sent: null
}

我不想删除 date_sent 键，我想明确地将其声明为 null。

swagger 规范不支持 anyOf 我相信 JSON 模式通常是这样做的。

我想知道是否有解决方法？也许某些可用于 Node 的库具有您可以添加的 x-nullable 供应商特定标志，或者以某种方式指定我的非必填字段都应该可以为空。

我是否必须自己编写一些东西来获取我的 swagger 文件，然后在验证器中间件运行之前对其进行修改，还是有人可以建议一些解决方法？

Answer 1

nullable 字段在 OpenAPI (fka Swagger) 规范中受支持 v3.0.0 ，但在 v2.0 中没有。可空类型定义如下:

# Can be string or null
type: string
nullable: true