SpringBoot15：集成Swagger

Swagger简介

前后端分离

• 前端 -> 前端控制层、视图层

  • 伪造后端数据 ，json

• 后端 -> 后端控制层、服务层、数据访问层

• 前后端通过API进行交互

• 前后端相对独立且松耦合

产生的问题

• 前后端集成，前端或者后端无法做到“及时协商，尽早解决”，最终导致问题集中爆发

解决方案

• 首先定义schema [ 计划的提纲 ]，并实时跟踪最新的API，降低集成风险

• 早些年：制定word计划

Swagger

• 号称世界上最流行的API框架

• Restful Api 文档在线自动生成器 => API 文档 与API 定义同步更新

• 直接运行，在线测试API

• 支持多种语言 （如：Java，PHP等）

• 官网：https://swagger.io/

SpringBoot集成Swagger

1、新建一个SpringBoot-web项目

2、添加Maven依赖

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>3.0.0</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>3.0.0</version>
        </dependency>

3、编写HelloController，测试确保运行成功！

4、要使用Swagger，我们需要编写一个配置类-SwaggerConfig来配置 Swagger

@Configuration //配置类
public class SwaggerConfig {  
}

Swagger 3 要在开始文件中加入@EnableOpenApi

5、访问测试 ：http://localhost:8080/swagger-ui/index.html ，可以看到swagger的界面；

我这里还加了其他的一些代码，所以有些可能和你们不一样

配置Swagger

1、Swagger实例Bean是Docket，所以通过配置Docket实例来配置Swaggger。

@Bean //配置docket以配置Swagger具体参数
public Docket docket() {
    return new Docket(DocumentationType.OAS_30);
}

2、可以通过apiInfo()属性配置文档信息

private ApiInfo apiInfo(){

    //作者信息
    Contact contact = new Contact("彭伟鑫", "https://blog.youkuaiyun.com/qq_43602877?spm=1001.2014.3001.5343", "867965365@qq.com");

    return new ApiInfo(
            "鑫哥的日志文档",      // 标题
            "帅的不谈哦",    // 描述
            "v1.0",             // 版本
            "https://blog.youkuaiyun.com/qq_43602877?spm=1001.2014.3001.5343",    // 组织链接
            contact,                    // 联系人信息
            "Apache 2.0",       // 许可
            "http://www.apache.org/licenses/LICENSE-2.0",           // 许可连接
            new ArrayList()             // 扩展
    );
}

3、Docket 实例关联上 apiInfo()

@Bean
public Docket docket() {
    return new Docket(DocumentationType.OAS_30).apiInfo(apiInfo());
}

4、重启项目，看下效果；

配置扫描接口

1、构建Docket时通过select()方法配置怎么扫描接口。

@Bean
public Docket docket() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
        .apis(RequestHandlerSelectors.basePackage("com.pwx.controller"))
        .build();
}

2、重启项目测试，查看效果

3、除了通过包路径配置扫描接口外，还可以通过配置其他方式扫描接口

//RequestHandlerSelectors：配置要扫描接口的方式
//basePackage:指定要扫描的包
//any():扫描全部
//none()：不扫描
//withClassAnnotation()：扫描类上的注解
//withMethodAnnotation():扫描方法上的注解

4、除此之外，我们还可以配置接口扫描过滤：

@Bean
public Docket docket() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
        .apis(RequestHandlerSelectors.basePackage("com.pwx.controller"))
        // 配置如何通过path过滤,即这里只扫描请求以/kuang开头的接口
        .paths(PathSelectors.ant("/pwx/**"))
        .build();
}

配置完运行我们就会发现，什么都没有扫到了

配置Swagger开关

1、通过enable()方法配置是否启用swagger，如果是false，swagger将不能在浏览器中访问了

2、如何动态配置当项目处于test、dev环境时显示swagger，处于prod时不显示？

//获取项目环境：
@Bean
    public Docket docket(Environment environment){

        // 设置要显示swagger的环境
        Profiles profiles = Profiles.of("dev", "test");
        // 判断当前是否处于该环境
        // 通过 enable() 接收此参数判断是否要显示
        boolean flag = environment.acceptsProfiles(profiles);

        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .enable(flag)  //是否启动swagger
                .groupName("pwx")
                .select()
                //RequestHandlerSelectors：配置要扫描接口的方式
                //basePackage:指定要扫描的包
                //any():扫描全部
                //none()：不扫描
                //withClassAnnotation()：扫描类上的注解
                //withMethodAnnotation():扫描方法上的注解
                .apis(RequestHandlerSelectors.basePackage("com.pwx.controller"))
                //过滤器，过滤什么路径
//                .paths(PathSelectors.ant("/pwx/**"))
                .build();
    }

3、可以在项目中增加一个dev的配置文件查看效果！

配置API分组

1、如果没有配置分组，默认是default。通过groupName()方法即可配置分组：

    @Bean
    public Docket docket1(Environment environment){
        return new Docket(DocumentationType.OAS_30)
                .groupName("A");
    }

2、重启项目查看分组

3、如何配置多个分组？配置多个分组只需要配置多个docket即可：

    @Bean
    public Docket docket1(Environment environment){
        return new Docket(DocumentationType.OAS_30)
                .groupName("A");
    }

    @Bean
    public Docket docket2(Environment environment){
        return new Docket(DocumentationType.OAS_30)
                .groupName("B");
    }

    @Bean
    public Docket docket3(Environment environment){
        return new Docket(DocumentationType.OAS_30)
                .groupName("C");
    }

4、重启项目查看即可

实体配置

1、新建一个实体类

@ApiModel("用户实体类")
public class User {
    @ApiModelProperty("用户名")
    public String username;
    @ApiModelProperty("密码")
    public String password;
}

2、只要这个实体在请求接口的返回值上（即使是泛型），都能映射到实体项中：

@PostMapping("/user")
    public User user(){
        return new User();
    }

3、重启查看测试

注：并不是因为@ApiModel这个注解让实体显示在这里了，而是只要出现在接口方法的返回值上的实体都会显示在这里，而@ApiModel和@ApiModelProperty这两个注解只是为实体添加注释的。

@ApiModel为类添加注释

@ApiModelProperty为类属性添加注释

常用注解
Swagger的所有注解定义在io.swagger.annotations包下

下面列一些经常用到的，未列举出来的可以另行查阅说明：

Swagger注解	简单说明
@Api(tags = “xxx模块说明”)	作用在模块类上
@ApiOperation(“xxx接口说明”)	作用在接口方法上
@ApiModel(“xxxPOJO说明”)	作用在模型类上：如VO、BO
@ApiModelProperty(value = “xxx属性说明”,hidden = true)	作用在类方法和属性上，hidden设置为true可以隐藏该属性
@ApiParam(“xxx参数说明”)	作用在参数、方法和字段上，类似@ApiModelProperty

最后

以上所有是通过在哔哩哔哩中遇见狂神说，狂神老师学习的，在这里表示热衷的感谢，有不懂的大家也可以去看看他的视频。

这是他的主页

大家也可以关注一下微信，我个人觉得讲的很好。