基于 knife4j 的 swagger配置

介绍
        使用Swagger你只需要按照亡的规范去定义接口及接口相关的信息，就可以做到生成接口文档，以及在线接口调试页面。
官网：https://swagger.io/

在这里使用的knife框架，对swagger进行了封装
knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案。

配置完后访问地址为 http://localhost:8080 (服务端口号)/doc.html

第一步：

导入knife4j的maven坐标

<dependency>
<groupld>com.github.xiaoymin</groupld>
<artifactld>knife4j-spring-boot-starter</artifactld>
<version> 3.0.2 </version>
</dependency>

第二步：

在配置类中加入knife4j相关配置

第三步：

设置静态资源映射，否则接口文档无法访问

@Configuration
@Slf4j
public class WebMvcConfiguration extends WebMvcConfigurationSupport {

   
    /**
     * 通过knife4j生成接口文档
     * @return
     */
    @Bean
    public Docket docket() {
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("标题") 
                .version("2.0")
                .description("项目接口文档描述")
                .build();
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xxx.controller")) /指定生成接口需要扫描的包目录
                .paths(PathSelectors.any())
                .build();
        return docket;
    }

    /**
     * 设置静态资源映射
     * @param registry
     */
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        // 固定写法
        registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}