整合篇：零基础整合Swagger2

Swagger2介绍

  前后端分离开发模式中，api文档是最好的沟通方式。

  Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

1. 及时性 (接口变更后，能够及时准确地通知相关前后端开发人员)
2. 规范性 (并且保证接口的规范性，如接口的地址，请求方式，参数及响应格式和错误信息)
3. 一致性 (接口信息一致，不会出现因开发人员拿到的文档版本不一致，而出现分歧)
4. 可测性 (直接在接口文档上进行测试，以方便理解业务)

Swagger2使用

导入相关依赖：

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

创建Swagger的配置类

@Configuration
public class SwaggerConfig {

    @Bean
    public Docket webApiConfig(){

        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi") //分组，可以设置多个docket
                .apiInfo(webApiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.jixiaolong.swagger"))
                .paths(PathSelectors.any())
                .build();

    }
    
    private ApiInfo webApiInfo(){

        return new ApiInfoBuilder()
                .title("请填写项目标题")
                .description("请填写项目描述")
                //请填写项目版本号
                .version("1.0")
                //请填写项目联系人信息（名称、网址、邮箱）
                .contact(new Contact("jxl", "http://jxl.com", "jxl@qq.com"))
                .build();
    }
}

在启动类上添加注释，开启框架功能

定义接口说明和参数说明
  定义在类上：@Api
  定义在方法上：@ApiOperation
  定义在参数上：@ApiParam

测试

编写controller

@RestController
//该注解用于描述当前控制器的作用
@Api(tags = "Swagger控制器")
public class SwaggerController {

    @PostMapping("/swagger")
    // value：描述该方法的作用，notes：描述该方法的备注信息
    @ApiOperation(value = "swagger", notes = "备注信息")
    // name：参数名称，value：参数说明，required：是否必填
    public String swagger(@ApiParam(name = "str", value = "字符", required = true) String str){
        return "swagger" + str;
    }
}

启动：
  访问地址为： http://localhost:8080/swagger-ui.html

Swagger2 美化

加强版 Swagger：knife4j

导入所需依赖：

  只导入这一个就可以了，之前导入的那两个可以全部删掉了，其他代码均保持不变即可

        <!--swagger-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <!--在引用时请在maven中央仓库搜索最新版本号-->
            <version>3.0.2</version>
        </dependency>

  访问地址为：http://localhost:8080/doc.html