（knife4j）Swagger-JAVAapi文档生成器

一、使用

1、导入knife4j的maven坐标

    com.github.xiaoymin
    knife4j-spring-boot-starter
    3.0.2

2、导入knife4j相关配置类

WebMvcConfig

注意代码中的汉字

@Slf4j
@Configuration
@EnableSwagger2
@EnableKnife4j
public class WebMvcConfig extends WebMvcConfigurationSupport {
  @Bean
  public Docket createRestApi() {
      //文档类型
      return new Docket(DocumentationType.SWAGGER_2)
              .apiInfo(apiInfo())
              .select()
              .apis(RequestHandlerSelectors.basePackage("com.ka.reggie.controller 这里放你controller包的位置"))
              .paths(PathSelectors.any())
              .build();
  }
  private ApiInfo apiInfo() {
      return new ApiInfoBuilder()
              .title("瑞吉外卖")
              .version("1.0")
              .description("瑞吉外卖接口文档")
              .build();
  }
}

3、设置静态资源，否则接口文档页面无法访问(addResourceHandlers方法)

registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");

4、在LoginCheckFilter中设置不需要处理的请求路径

因为我做了一个filter的WebFilter的拦截器，所以我需要放开下面的路径，如果你没有配置，则不需要放开

String[] urls = new String[]{
        "/doc.html",
        "/webjars/**",
        "/swagger-resources",
        "/v2/api-docs"
};

二、常用注解