时间戳

首页 > 解决方案 > Swashbuckle.AspNetCore openapi 架构中未正确显示可空属性

c# - Swashbuckle.AspNetCore openapi 架构中未正确显示可空属性

问题描述

Swashbuckle.AspNetCore v6.0.7在asp.net core项目中使用net5.0。

假设我有这样的模型：

public enum MyEnum
{
  A, B
}

和

public class MyModel 
{
   public MyEnum MyEnum { get; set; }
   public MyEnum? MyEnum2 { get; set; }
}

并且大摇大摆的模式是这样生成的：

"MyEnum": {
        "enum": [
          "A",
          "B"
        ],
        "type": "string"
      },
      "MyModel": {
        "type": "object",
        "properties": {
          "myEnum": {
            "$ref": "#/components/schemas/MyEnum"
          },
          "myEnum2": {
            "$ref": "#/components/schemas/MyEnum"
          }
        },
        "additionalProperties": false
      }

如您所见，open-API JSON 模式之间没有MyEnum区别MyEnum?！

并且似乎可以为空的枚举未正确显示在架构中。

有谁知道我该如何解决这个问题？

最好的

标签： c#asp.net-coreswaggerswashbuckle.aspnetcore

解决方案

按照尤依依的建议，我是这样打UseAllOfToExtendReferenceSchemas进来的SwaggerGenOptions：

services.AddSwaggerGen(c =>
{
       c.UseAllOfToExtendReferenceSchemas();
});

现在生成的模式如下：

"MyEnum": {
        "enum": [
          "A",
          "B"
        ],
        "type": "string"
      },
      "MyModel": {
        "type": "object",
        "properties": {
          "myEnum": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MyEnum"
              }
            ]
          },
          "myEnum2": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MyEnum"
              }
            ],
            "nullable": true
          }
        },
        "additionalProperties": false
      },

并且有"nullable": true类型MyEnum?。

您可以在此处找到更多信息。

感谢Yiyi You.

推荐阅读