Spring Boot 整合 Swagger3

​ 前后端分离的项目，接口文档的存在十分重要。与手动编写接口文档不同，Swagger 是一个自动生成接口文档的工具，在需求不断变更的环境下，手动编写文档的效率实在太低。与 Swagger2 相比新版的 Swagger3 配置更少，使用更加方便。

---

---

1、引入依赖

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

---

---

2、编写配置类

@Configuration
@EnableOpenApi
public class Swagger3Config {

    @Bean
    public Docket webApiConfig(){

        return new Docket(DocumentationType.OAS_30)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xxich"))
                .paths(PathSelectors.any())
                .build();
    }


    private ApiInfo webApiInfo(){
        return new ApiInfoBuilder()
                .title("非遗项目 API 文档")
                .description("本文档描述了非遗各个微服务接口定义")
                .version("1.0")
                .contact(new Contact("yanghui", "http://yanghui.com",
                        "yanghui@qq.com"))
                .build();
    }
}

---

---

3、注解的使用说明

@Api：用在请求的类上，表示对类的说明
    tags ="说明该类的作用，可以在UI界面上看到的注解"
    value = "该参数没什么意义，在UI界面上也看到，所以不需要配置"

@ApiOperation：用在请求的方法上，说明方法的用途、作用
    value = "说明方法的用途、作用"
    notes = "方法的备注说明"
    
@ApiParam：用在请求的参数上
    value = "说明参数的用途"
    
@ApiImplicitParams：用在请求的方法上，表示一组参数说明
    @ApiImplicitParam：用在 @ApiImplicitParams 注解中，指定一个请求参数的各个方面
        name：参数名
        value：参数的汉字说明、解释
        required：参数是否必须传
        paramType：参数放在哪个地方
            · header --> 请求参数的获取：@RequestHeader
            · query --> 请求参数的获取：@RequestParam
            · path（用于restful接口）--> 请求参数的获取：@PathVariable
            · div（不常用）
            · form（不常用）    
        dataType：参数类型，默认String，其它值dataType="Integer"       
        defaultValue：参数的默认值

@ApiResponses：用在请求的方法上，表示一组响应
    @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
        code：数字，例如400
        message：信息，例如"请求参数没填好"
        response：抛出异常的类

@ApiModel：用于响应类上，表示一个返回响应数据的信息
            （这种一般用在post创建的时候，使用@RequestBody这样的场景，
            请求参数无法使用@ApiImplicitParam注解进行描述的时候）
@ApiModelProperty：用在属性上，描述响应类的属性

---

例如：

---

---

4、进行测试

访问地址：http://localhost:8001/swagger-ui/

注意：主机和端口号填写你自己的

---

测试成功：

---