Swagger的介绍以及使用

今天学习了Swagger。Swagger是一个规范且完整的框架，用于生成、描述、调用以及可视化RESTful风格的web服务。
其主要的功能：

有利于进行前后端分离式开发，有利于团队协作
自动生成接口文档，缓解编写接口文档的压力
进行功能测试
现如今Spring已经将Swagger纳入自身的标准，建立了Spring-swagger项目，现在叫Springfox。通过在项目中引入Springfox ，即可非常简单快捷的使用Swagger。knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望它能像一把匕首一样小巧,轻量,并且功能强悍!目前，一般都使用knife4j框架。

对于Swagger的使用步骤：

导入knife4j的maven坐标

<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>knife4j-spring-boot-starter</artifactId>
</dependency>

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

@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.sky.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }

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

protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}

需要注意两个位置：

设置静态资源映射中，如果不去设置静态资源映射的话，那么在输入接口文档访问路径中不会去看到自动生成的接口文档的页面，会报一个404的错误
在进行配置类中加入knife4j相关配置，.apis(RequestHandlerSelectors.basePackage("com.sky.controller"))这一块会进行该路径的包及其子包扫描中，如果输入的路径错误，那么在生成时，会出现接口文档的页面，但是不会出现信息。