【任雨杰真帅啊】 4. SpringBoot 整合 Swagger2在线文档

我打算创建一个专栏,主要用于结合八股文和各种场景题来进行代码实践，包括但不限制于集成各种中间件去实现对应的场景和工具封装，该文章为SpringBoot专栏的一个系列，希望大家观看以后帮我多多点赞评论。

大家的点赞和关注是我创作的动力，实属不易，谢谢大家~

Swagger2 是一个开源项目，用于RESTful Web服务生成REST API文档。它提供了一个用户界面，可以通过Web浏览器访问我们的RESTful Web服务，测试接口。
《本文主要参考入门小站文章》 特此说明

📕 引入pom依赖

<!-- Spring Boot Swagger Starter -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>
<!-- Spring Boot Swagger UI Starter -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>3.0.0</version>
</dependency>

📕 添加Swagger配置文件

package com.yjren.yjrenweb.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration
public class SwaggerConfig {

    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.yjren.yjrenweb.controller"))
                .paths(PathSelectors.any()).build();
    }
    private ApiInfo apiInfo(){
        Contact contact=new Contact("Swagger2接口文档", "https://yjren.com", "15835125802@163.com");
        return new ApiInfoBuilder()
                .title("Swagger2接口文档")
                .description("https://yjren.com")
                .contact(contact).build();
    }
}

📕 增加配置，防止版本冲突

# 处理SpringBoot2.6.x与Swagger2 3.0.0版本冲突
spring.mvc.pathmatch.matching-strategy=ant_path_matcher

📕 启动类添加开启Swagger开关

📕 浏览器访问接口文档

浏览器访问http://127.0.0.1:8080/swagger-ui/

📕 Swagger2常用注解

@Api

@Api用在类上,用于说明类功能的说明

@Api(tags = "入门小站Controller入口",value = "页面上看不见的内容")

@ApiOperation

@ApiOperation(value = "方法的作用说明",notes = "方法的备注说明")

@ApiImplicitParams,@ApiImplicitParam
入参数说明

@ApiImplicitParams({@ApiImplicitParam(name = “page”,value = “当前页”),@ApiImplicitParam(name = “pageSize”,value = “分页大小”)})

@ApiImplicitParam其它参数

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

@ApiResponses

明请求返回的状态码及描述

@ApiResponses({@ApiResponse(code = 200,message = "成功"),@ApiResponse(code=201,message = "参数错误")})

@ApiModel

描述实体类

@ApiModel(“用戶信息”)

@ApiModelProperty

描述实体类的属性

@ApiModelProperty(value = "名字",name = "name",example = "入门小站")