定义一个自定义的json序列化器，用于springfox swagger2 for@Api运算

Question

我有一个简单的rest api，实现了单个GET方法。我想用springfox和swagger来记录它。一切都很容易期待样品反应。

默认情况下，springfox使用基于反射的序列化程序-生成包含java类的所有公共字段的简单json-我想更改此行为并使用自定义序列化程序。

这是我的控制器（为了这个问题，大部分代码都被简化了）：

@RestController
public class Controller {

@RequestMapping( value = "/GetResponse", produces = MediaType.APPLICATION_JSON_UTF8_VALUE, method = RequestMethod.GET )
    public Response getResponse( )  {
        return Response.randomInstance();
    }

}

响应类是运行时生成的——我不能编辑/修改那个类，所以像@ApiModelProperty这样的注释是不可行的。默认情况下，我使用自定义序列化器（静态响应转换器也是自动生成的）：

@JsonComponent
public  class Serializer extends JsonSerializer<Response> {
    @Override
    public void serialize(Response response, JsonGenerator generator, SerializerProvider provider)
            throws IOException {
        generator.writeRaw( StaticResponseConverter.toJson(response) );
    }
}

对于常规api调用，此序列化程序可以正常工作。但是，在生成样本响应时，swagger2不会使用它。

招摇过市配置：

@Configuration
@EnableSwagger2
public class SwaggerConfig
{
    @Bean
    public Docket api()
    {
        return new Docket( DocumentationType.SWAGGER_2 ).select()
                .apis( x -> x.declaringClass().equals( Controller.class ) ).paths( PathSelectors.any() )
                .build();
    }
}

我尝试过这种方法：

为swagger生成JSON模型时，Spingfox无法识别自定义序列化程序

也有这种方法，但我无法将其应用于springfox。

Swagger是可以覆盖自定义对象序列化

Maven配置：

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.6.1</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.6.1</version>
        </dependency>

如何使springfox/swagger在生成swagger-ui.html.的示例响应时使用我的自定义json序列化器

Answer 1

我第二个方法提供了这个答案，通过提供一个模型：

• adirectModelSubstitute或
• a通用模型替代或
• 提供备用类型规则

这样做的目的是帮助springfox模式推理引擎推断它无法推断的内容。使用序列化器对jackson是不透明的，因此对springfox也是如此。这是因为通过检查序列化器的实现很难知道特定类型是如何通过线路序列化/反序列化的。