Springfox boot starter招摇过市瞬间操控

Question

我对使用SpringBoot和Springfox-boot-starter的swagger文档有一个问题。

我使用java.time.Instant java.util.Optio包裹

  @GetMapping("/{subscriptionId}/{variableAlias}")
  public PaginatedResultDTO<MonitoredVariableDTO> getReportedVariables(
    @PathVariable String subscriptionId, 
    @PathVariable String variableAlias, 
    Optional<Instant> from, 
    Optional<Instant> to) { ... }

有没有办法让这个工作与可选的？感谢任何建议！

Spring启动版本:

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.3.4.RELEASE</version>
    <relativePath />
</parent>

Springfox-boot-starter版本

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

Answer 1

spring fox的问题是它不使用您定义为< code>Bean的自定义< code>ObjectMapper。

Springfox使用new关键字创建自己的ObjectMapper。因此，您向自定义对象映射器注册的任何模块对于SpringFox来说都是毫无意义的。但是，Springfox提供了一个接口，用于将模块注册到它自己的ObjectMapper。

在项目中创建一个如下所示的配置bean，它应该可以工作。

@Configuration
public class ObjectMapperModuleRegistrar implements JacksonModuleRegistrar {
  @Override
  public void maybeRegisterModule(ObjectMapper objectMapper) {
    objectMapper.registerModule(new ParameterNamesModule())
        .registerModule(new Jdk8Module())
        .registerModule(new JavaTimeModule())
        .findAndRegisterModules();
  }
}

Answer 2

我们遇到了和你完全一样的问题。我们用SpringFox的配置解决了这个问题:

@Configuration
@EnableSwagger2
public class SpringfoxConfiguration {

    @Value("${api-doc.version}")
    private String apiInfoVersion;

    @Autowired
    private TypeResolver typeResolver;
    @Bean
    public Docket customDocket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("xxx")
                //Some other code unrelated to this problem
                .alternateTypeRules(
                        // Rule to correctly process Optional<Instant> variables
                        // and generate "type: string, format: date-time", as for Instant variables,
                        // instead of "$ref" : "#/definitions/Instant"
                        AlternateTypeRules.newRule(
                                typeResolver.resolve(Optional.class, Instant.class),
                                typeResolver.resolve(Date.class), 
                                Ordered.HIGHEST_PRECEDENCE
                        ))
                .genericModelSubstitutes(Optional.class)
                .select()
                //Some more code unrelated to this problem
                .build();
    }
}