使用OpenAPI（swagger）JSON模式定义对空值进行模式验证

Question

我正在寻找一个解决方案来解决Swagger（OpenAPI）数据类型和JSON模式之间处理数据类型空值的不兼容性。

我们的swagger文件包含所有模式定义，我想使用JSON。Net模式，用于API测试中的模式验证步骤。

有效的swagger属性定义：

  "description": {
    "type": "string",
    "nullable": true
  }

将失败JSON模式验证空值（无效类型。预期字符串，但得到空值）。

如果我将可为空的属性定义替换为：

  "description": {
    "type": ["string", "null"]
  } 

对于空值，验证将是成功的，但这打破了昂首阔步的语法。

Structural error at components.schemas.CalendarFunctionsDto.properties.description_EN.type
should be equal to one of the allowed values
allowedValues: array, boolean, integer, number, object, string

我找不到的OpenAPI模式到JSON模式转换器。网我想知道是否有一个简单的解决方案可以使用JSON。Net模式来解决这个问题。我们的一些类型比上面的例子更复杂。我正在寻找一种适用于所有“可空”类型的解决方案。

理想情况下，我希望为输入保留有效的swagger（OpenAPI 3.0）JSON语法，以编程方式为所有可为空的属性（转换模式、调整验证或任何其他创造性解决方案）在C#中执行一些拼写，然后使用JSON验证模式。Net架构。

Answer 1

Openapi 3.0.0/3.0.1/3.0.2/3.0.3不支持null类型，它只支持nullable。JSON模式不支持nullable，它支持null类型。你能把你的规范升级到Openapi v3吗。1.0? 该版本支持空类型。然后，您可以使用以下选项之一：

选项1（不太可能在openapi工具中工作，因为类型数组是这样一个新添加）

  "description": {
    "type": ["string", "null"]
  } 

选项2（更有可能使用openpi工具，因为类型不是数组）

  "description": {
    "oneOf" [
        {"type": "string"},
        {"type": "null"},
    ]
  }