C# 更改由Swagger/Swashback导出的特性类型

我有一个相当复杂的对象和嵌套对象；请注意，在下面的例子中，我已经大大简化了这个对象

假设以下示例对象：

public class Result {
    public string Name { get; set; }
    public IpAddress IpAddress { get; set; }
}

我实现了一个

JsonConverter

，然后将Ip反序列化为字符串：

public class IPAddressConverter : JsonConverter<IPAddress>
{
    public override IPAddress Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
        => IPAddress.Parse(reader.GetString());

    public override void Write(Utf8JsonWriter writer, IPAddress value, JsonSerializerOptions options)
        => writer.WriteStringValue(value.ToString());
}

反之亦然，我的控制器“理解”指定为字符串的IP地址：

public IEnumerable<Result> FindByIp(IpAddress ip) {
    // ...
}

对于更具视觉倾向的人来说，这看起来像：

然而，我想要实现的是：

{
  "openapi": "3.0.1",
  "info": {
    "title": "Example",
    "version": "v1"
  },
  "paths": {
    "/FindByIp": {
      "get": {
        "parameters": [
          {
            "name": "q",
            "in": "query",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "$ref": "#/components/schemas/Result"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Result": {
        "type": "object",
        "properties": {
          "ip": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      }
    }
  }
}

再次，可视化：

我希望能够在一些属性上添加注释/属性（所以我查看了），但这似乎不可能

此外，由于对象相当复杂，并且来自第三方库，因此我很难在属性上添加注释/属性，因为我无法（轻松地）更改模型

我可以使用AutoMapper（或类似工具）创建另一个带有IP地址字符串的模型，但这意味着必须在原始模型中对所有对象建模。此外，当模型发生变化时，它需要额外的代码和维护。我宁愿告诉Swashback，不知何故，IP地址（因此，类型将表示为字符串（传入和传出到我的API）。我正在寻找如何在给定限制内以最佳方式实现这一点的选项（最好不要引入要映射到的新模型，最好不要添加注释/属性，因为我无法轻松访问第三方库）。有没有办法为Swashback注册一个“类型转换器”来处理这个问题

更新：！ 这就是我的结局：

// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
    services
        .AddResponseCompression()
        .AddMemoryCache()
        .AddControllers()
        // etc...
        // etc...

    // Here's the interesting part:
    services.AddSwaggerGen(c =>
        {
            c.SwaggerDoc("v1", new OpenApiInfo { Title = "Example", Version = "v1" });
            c.MapType<IPAddress>(() => new OpenApiSchema { Type = typeof(string).Name });
            // ...
        });
}

//此方法由运行时调用。使用此方法可将服务添加到容器中。
public void配置服务（IServiceCollection服务）
{
服务
.AddResponseCompression（）
.AddMemoryCache（）文件
.AddControllers（）
//等等。。。
//等等。。。
//有趣的是：
services.AddSwaggerGen（c=>
{
c、 SwaggerDoc（“v1”，新OpenApiInfo{Title=“Example”，Version=“v1”}）；
c、 MapType（（）=>newOpenAPISchema{Type=typeof（string.Name}）；
// ...
});
}

---

谢谢您

当您转换为非复杂类型时，您应该能够使用

MapType

来处理此IPAddress示例：

swagger.MapType<IPAddress>(() => new Schema { Type = "string" });

swagger.MapType（（）=>newschema{Type=“string”}）；

---

如果您要转换为复杂类型，那么您需要使用。

哇，这正是我想要的，而且非常简单！不过，当我使用5.0.0-rc4时，我不得不将

Schema

更改为

OpenApiSchema

。除此之外，它工作得非常好！谢谢！

swagger.MapType<IPAddress>(() => new Schema { Type = "string" });