使用Swashback自定义生成模型文档

Question

我正在使用Swashback为ASP生成swagger文档。NET核心API我正在写。在我的API中，我使用了许多自定义Json转换器，因此我接收和返回的Json看起来与C类的定义不完全一样。例如，我可能有这样一个类：

public class MyModel
{
    private MyClass complicatedField;
}

它将被序列化为

{
    "complicatedField": "String representation of the object"
}

然而，Swashuckle将其记录为

{
    "complicatedField": {/*Json object of all the fields MyClass has*/}
}

我如何告诉Swashback我的模型是如何序列化和反序列化的？

Answer 1

由于要将类型更改为基元，因此可以使用映射类型。否则，您将使用SchemaFilter。

.Net框架在启动时调用扩展方法，即程序。反恐精英

httpConfiguration.EnableSwagger(c =>
      {
          c.MapType<MyClass>(() => new Schema { type = "string" }); // add additional schema info here
          // other configs
      });

. Net Core在startup.cs配置服务方法中的位置

services.AddSwaggerGen(c =>
     {
          c.MapType<MyClass>(() => new Schema { Type = "string" });// add additional schema info here
          // other configs
     });