Swagger

1. 介绍

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务（https://swagger.io/ ）。它的主要作用是：

使得前后端分离开发更加方便，有利于团队协作
接口的文档在线自动生成，降低后端开发人员编写接口文档的负担
功能测试

Spring已经将Swagger纳入自身的标准，建立了Spring-swagger项目，现在叫Springfox。通过在项目中引入Springfox ，即可非常简单快捷的使用Swagger。

knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案，前身是swagger-bootstrap-ui，取名kni4j是希望它能像一把匕首一样小巧，轻量，并且功能强悍。

目前，一般都使用knife4j框架。

2 使用步骤

2.1 导入 knife4j 的maven坐标

在pom.xml中添加依赖

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

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

WebMvcConfiguration.java

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

2.3 设置静态资源映射

WebMvcConfiguration.java

/**
     * 设置静态资源映射
     * @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/");
}

2.4 访问测试

接口文档访问路径为 http://ip:port/doc.html -> http://localhost:8080/doc.html

思考：通过 Swagger 就可以生成接口文档，那么我们就不需要 Yapi 了？答案：需要。

Yapi 是设计阶段使用的工具，管理和维护接口

Swagger 在开发阶段使用的框架，帮助后端开发人员做后端的接口测试

3. 常用注解

通过注解可以控制生成的接口文档，使接口文档拥有更好的可读性，常用注解如下：

注解	说明
@Api	用在类上，例如Controller，表示对类的说明
@ApiOperation	用在方法上，例如Controller的方法，说明方法的用途、作用
@ApiModel	用在类上，例如entity、DTO、VO
@ApiModelProperty	用在属性上，描述属性信息

例如：

在sky-server模块中：
EmployeeController.java

@RestController
@RequestMapping("/admin/employee")
@Slf4j
@Api(tags = "员工相关接口")	// @Api 注解
public class EmployeeController {
	……
    @PostMapping("/login")
    @ApiOperation(value = "员工登录")	// @ApiOperation 注解
    public Result<EmployeeLoginVO> login(@RequestBody EmployeeLoginDTO employeeLoginDTO) 	{
        //..............
    }
    ……
}

在sky-pojo模块中：
EmployeeLoginDTO.java

@Data
@ApiModel(description = "员工登录时传递的数据模型")	// @ApiModel 注解
public class EmployeeLoginDTO implements Serializable {
    @ApiModelProperty("用户名")	// @ApiModelProperty 注解
    private String username;
    @ApiModelProperty("密码")	// @ApiModelProperty 注解
    private String password;
}

Parker's Blog