java - Spring Boot 验证信息未显示在 Swagger UI 中

Question

我的类是用 Spring Boot Java 编写的，我使用 Swagger 2 生成它们的文档。 我正在使用 spring-fox 版本 2.9.0。

为了在 Swagger UI 中显示验证约束(@min、@max、@pattern 等)，我将以下几行添加到我的 application.java 中，其中 showExtensions(true) ，但这没有用。 Swagger UI 中的预期结果

我应该改变什么才能得到想要的结果？

@Bean
UiConfiguration uiConfig() {
  return UiConfigurationBuilder.builder() 
      .deepLinking(true)
      .displayOperationId(false)
      .defaultModelsExpandDepth(1)
      .defaultModelExpandDepth(1)
      .defaultModelRendering(ModelRendering.EXAMPLE)
      .displayRequestDuration(false)
      .docExpansion(DocExpansion.NONE)
      .filter(false)
      .maxDisplayedTags(null)
      .operationsSorter(OperationsSorter.ALPHA)
      .showExtensions(true)
      .tagsSorter(TagsSorter.ALPHA)
      .supportedSubmitMethods(UiConfiguration.Constants.DEFAULT_SUBMIT_METHODS)
      .validatorUrl(null)
      .build();
}

Answer 1

你的UiConfiguration没问题。您需要做的是(激活Springfox对JSR-303的支持参见Springfox Reference Documentation):

• 将 springfox-bean-validators 依赖项添加到 pom.xml 中:

  <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-bean-validators</artifactId>
      <version>2.9.2</version> <!-- or any version you like -->
  </dependency>
  

• 从springfox-bean-validators模块导入配置:

  ...
  @Import({springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration.class})
  public class SwaggerDocumentationConfig { ... }
  

现在您应该能够在 Swagger UI 中带注释的属性顶部看到所需的信息。