Swagger的用法

在前后端分离项目时，对于后端的访问接口常常需要写十分详细的文档，但是在后端更改后，有时候又很难及时更新文档，很是麻烦。这时候，Swagger就可以很好的解决这个问题，前端人员可以直接在网页中看到有哪些功能，并且还可以测试一下。
下面，就在 SpringBoot 项目中加入 Swagger。

第一步：导包

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

第二步：配置

package com.coder.umserver.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author : 
 * @date : 2020-03-28 16:29
 * @description : swagger的配置
 */

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any()).build();
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder().build();
    }
}

这时候，我们就可以启动应用程序，在浏览器中输入 http://localhost:8080/swagger-ui.html#/查看到 Api。

第三步：添加描述

如果是上面那样显示，前端人员有时候还是不能很好的看明白功能，所有可以在 controller 层对类、方法、参数、bean添加上中文的描述，使文档更加的清楚。

@RestController
@Api(value = "aaaa")
public class EmployeeController {
    @Autowired
    private EmployeeService employeeService;

    @DeleteMapping("/emp/{ids}")
    @ApiOperation(value = "根据 ids 批量删除员工信息")
    public HttpResult deleteEmp(
            @ApiParam(value = "用户的id，如果是批量删除，则id以英文 `,` 隔开") 
            @PathVariable String ids) {
        int row = employeeService.deleteEmp(ids);
        if (row > 0) {
            return HttpResult.ok("删除成功!");
        }
        return HttpResult.error("删除失败!");
    }
}

在方法上加上 @ApiOperation 注解，可以附加的参数包括：

属性	描述
value	未展开状态下的备注信息
notes	展开状态下方法备注信息，和value相比，value是未展开状态下的备注，一般会写的比较简短，而notes可以写的比较详细

还可以给参数加上注解 @ApiParam，可以附加的参数包括：

属性	描述
value	参数备注信息
required	是否是必填项，默认为false

如果参数是一个对象，例如 Employee 对象，则可以用 @ApiModelProperty 注解给每个属性添加备注，可以附加的参数包括：

属性	描述
value	属性备注信息

整体效果如下：