springfox-data-rest 配置不起作用

Question

我跟着link去配置。

<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-data-rest</artifactId>
  <version>2.7.0</version>
</dependency> 

@Configuration
@Import( {springfox.documentation.spring.data.rest.configuration.SpringDataRestConfiguration.class})
public class WebMvcConfig extends WebMvcConfigurerAdapter{
     ......
}

@RepositoryRestResource(collectionResourceRel = "mails", path = "mails")
public interface TMessageMailDao extends   PagingAndSortingRepository<TMessageMail, Long>{


}

但是当我打开http://localhost:8080/swagger-ui.html 时，什么都没有。

我知道 springfox-data-rest 仍在孵化中。这就是它不起作用的原因吗？还是有什么问题？

Answer 1

• 您缺少@EnableSwagger2 注释。

• 确保创建一个Docket bean，如下例所示。

  @Configuration
  @Import({SpringDataRestConfiguration.class})
  @EnableSwagger2
  public class WebMvcConfig extends WebMvcConfigurerAdapter {
      ...
      @Bean
      public Docket api() {
          return new Docket(DocumentationType.SWAGGER_2)
              .groupName("example")
              .select()
              .paths(PathSelectors.any())
              .build()
              .apiInfo(apiInfo("Example API", "Example API"));
      }
  
      private ApiInfo apiInfo(String title, String description) {
           return new ApiInfoBuilder()
               .title(title)
               .description(description)
               .build();
     }
  }
  

• 确保添加以下依赖项：

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

一旦它开始工作，您的swagger-ui.html 将如下所示：

我想扫描两个包裹。如何包含两个基础包而不是一个？

只是控制器

如果您只对包含 REST 控制器而不是任何存储库感兴趣，您可以借助自定义方法在 Docket 的 apis 方法中指定任意数量的包。

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("book")
                .select()
                .apis(exactPackages("com.basaki.controller", "com.basaki.model"))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo("Example Springfox API",
                        "Example Springfox API"));
    }

    private static Predicate<RequestHandler> exactPackages(
            final String... pkgs) {
        return input -> {
            String currentPkg = 
                input.declaringClass().getPackage().getName();
            for (String pkg : pkgs) {
                if (pkg.equals(currentPkg)) {
                    return true;
                }
            }
            return false;
        };
    }

控制器和存储库

如果您对包含 REST 控制器和存储库感兴趣，则必须借助自定义方法在 Docket 中利用 paths 方法。自定义方法采用路径正则表达式。

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("book")
                .select()
                .paths(matchPathRegex("/books(/|$).*",
                    "/booxs(/|$).*", "/tokens(/|$).*",
                    "/ping(/|$).*"))
                .build()
                .apiInfo(apiInfo("Example Springfox API",
                        "Example Springfox API"));
    }

    private static Predicate<String> matchPathRegex(final String... pathRegexs) {
        return new Predicate<String>() {
            @Override
            public boolean apply(String input) {
                for (String pathRegex : pathRegexs) {
                    if (input.matches(pathRegex)) {
                        return true;
                    }
                }
                return false;
            }
        };
    }

Answer 2

感谢 Indra Basak 的帮助。
我的配置只有一个问题。

@Configuration
@EnableSwagger2
@Import({SpringDataRestConfiguration.class})

这三个注解必须一起使用。我在另一个配置文件中配置@EnableSwagger2。