【SpringCloud】SpringBoot集成Swagger 常用Swagger注解

概述：SpringBoot集成Swagger 常用Swagger注解

导语

相信无论是前端还是后端开发，都或多或少地被接口文档折磨过。前端经常抱怨后端给的接口文档与实际情况不一致。后端又觉得编写及维护接口文档会耗费不少精力，经常来不及更新。其实无论是前端调用后端，还是后端调用后端，都期望有一个好的接口文档。但是这个接口文档对于程序员来说，就跟注释一样，经常会抱怨别人写的代码没有写注释，然而自己写起代码起来，最讨厌的，也是写注释。所以仅仅只通过强制来规范大家是不够的，随着时间推移，版本迭代，接口文档往往很容易就跟不上代码了

Swagger是什么？它能干什么？

官网地址：https://swagger.io/

发现了痛点就要去找解决方案。解决方案用的人多了，就成了标准的规范，这就是Swagger 的由来。

通过这套规范，你只需要按照它的规范去定义接口及接口相关的信息。再通过Swagger 衍生出来的一系列项目和工具，就可以做到生成各种格式的接口文档 ， 生成多种语言的客户端和服务端的代码，以及在线接口调试页面等等 。这样，如果按照新的开发模式，在开发新版本或者迭代版本的时候，只需要更新Swagger描述文件，就可以自动生成接口文档和客户端服务端代码，做到调用端代码、服务端代码以及接口文档的一致性。

框架说明

现在SWAGGER官网主要提供了几种开源工具，提供相应的功能。可以通过配置甚至是修改源码以达到你想要的效果：

作用：

1. 接口的文档在线自动生成
2. 功能测试

Spring集成Swagger

初始实现步骤

添加Maven依赖

 <!--        bootstrap-ui   访问http://localhost:8080/doc.html-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.1</version>
        </dependency>
         <!--        swagger依赖 访问http://localhost:8080/swagger-ui.html-->
        <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>

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

package com.stringzhua.springcloud_swagger01.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @Author Stringzhua
 * @Date 2024/9/30 11:41
 * description:
 */
@RestController
public class HelloController {
    @RequestMapping("/hello")
    public String hello() {
        return "hello swagger";
    }
}

编写一个配置类-SwaggerConfig来配置 Swagger

@Configuration//配置类
@EnableSwagger2// 开启Swagger2的自动配置
public class SwaggerConfig {

}

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

如果启动报错空指针是因为springboot2.6.0中将SpringMVC 默认路径匹配策略从AntPathMatcher 更 改为PathPatternParser，导致出错

可以在启动类上加上@EnableWebMvc注解或者在配置中切换为原先的AntPathMatcher（加注解不太行）

spring.mvc.pathmatch.matching-strategy=ant_path_matcher

配置Swagger

Swagger实例Bean是Docket，所以通过配置Docket实例来配置Swagger

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

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

 //配置文档信息
    private ApiInfo apiInfo() {
        Contact contact = new Contact("联系人名字", "http://xxx.xxx.com/联系人访问链接", "联系人邮箱");
        return new ApiInfo(
                "Swagger学习", // 标题
                "学习演示如何配置Swagger", // 描述
                "v2.0", // 版本
                "http://zkt .com", // 组织链接
                contact, // 联系人信息
                "Apach 2.0 许可", // 许可
                "许可链接", // 许可连接
                new ArrayList<>()// 扩展
        );
    }

Docket 实例关联上 apiInfo()

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

重启项目，访问测试 http://localhost:8080/swagger-ui.html 看下效果；

配置扫描接口

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

 @Bean //配置docket以配置Swagger具体参数
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("hello") // 配置分组
                .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
                .apis(RequestHandlerSelectors.basePackage("com.zkt.springboot_swagger01.controller"))
                .paths(PathSelectors.any())
                .build();
    }

重启项目测试，由于我们配置根据包的路径扫描接口，所以我们只能看到一个类

除了通过包路径配置扫描接口外，还可以通过配置其他方式扫描接口，这里注释一下所有的配置方式

any() // 扫描所有，项目中的所有接口都会被扫描到
none() // 不扫描接口
// 通过方法上的注解扫描，如withMethodAnnotation(GetMapping.class)只扫描get请求
withMethodAnnotation(final Class<? extends Annotation> annotation)
// 通过类上的注解扫描，如.withClassAnnotation(Controller.class)只扫描有controller注解
的类中的接口
withClassAnnotation(final Class<? extends Annotation> annotation)
basePackage(final String basePackage) // 根据包路径扫描接口

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

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

这里的可选值还有

any() // 任何请求都扫描
none() // 任何请求都不扫描
regex(final String pathRegex) // 通过正则表达式控制
ant(final String antPattern) // 通过ant()控制

配置API分组

1. 如果没有配置分组，默认是default。通过groupName()方法即可配置分组
2. 重启项目查看分组
3. 如何配置多个分组？配置多个分组只需要配置多个docket即可：

@Bean
public Docket docket1(){
    return new Docket(DocumentationType.SWAGGER_2).groupName("group1");
}
@Bean
public Docket docket2(){
    return new Docket(DocumentationType.SWAGGER_2).groupName("group2");
}
@Bean
public Docket docket3(){
    return new Docket(DocumentationType.SWAGGER_2).groupName("group3");
}

拓展：其他皮肤

我们可以导入不同的包实现不同的皮肤定义

1. 默认的访问 http://localhost:8080/swagger-ui.html

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

2. bootstrap-ui 访问 ****http://localhost:8080/doc.html

常用Swagger注解

Swagger通过注解生成接口文档，包括接口名、请求方法、参数、返回信息等等。

@Api

修饰整个类，描述Controller的作用

语法：@Api(tag=“类的作用，可以在UI界面上看到的注释”, value=“/类的访问路径”, description=“类的文字描述”)

@ApiOperation

描述一个类的一个方法，说明方法的作用

语法：@ApiOperation(value=“接口名称”, httpMethod=“接口请求方式”, response=“接口返回 参数类型”, notes=“接口发布说明”)

@ApiImplicitParam

一个请求参数

语法：@ApiImplicitParam(required=“是否必须参数”, name=“参数名称”, value=“参数具体描述”, dataType=“变量类型”, paramType=“请求方式” )

header -> 请求参数的获取:@RequestHeader

query -> 请求参数的获取:@RequestParam

path（用于restful接口）-> 请求参数的获取:@PathVariable

body（不常用） -> 请求参数的获取:@RequestBody

form（不常用） -> 请求参数的获取:@RequestParam

@ApiImplicitParams

多个请求参数

@ApiParam

单个参数描述

语法：@ApiParam(required=“是否必须参数”, name=“参数名称”, value=“参数具体描述”,dataType=“变量类型”,paramType=“请求方式”)

@ApiResponse

HTTP响应应答描述

语法：@ApiResponse(code=400, message=“Invalid user supplied”)

@ApiResponses

HTTP响应整体描述

语法：@ApiResponses({@ApiResponse(code=400, message=“Invalid Order”)})

@ApiModel

用对象实体类作为入参

@ApiModelProperty

用对象接收参数时，描述对象的一个字段

@ApiIgnore

使用该注解忽略这个API

@ApiError

发生错误返回的信息

演示

编码：

POJO层：

Admin.java

package com.stringzhua.springboot_swagger02.pojo;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.sql.Date;



@Data
@NoArgsConstructor
@AllArgsConstructor
@ApiModel(value = "管理员实体列",description = "管理员实体类")
public class Admin {
    @ApiModelProperty(name = "adminId",value = "管理员编号",example = "001")
    private int adminId;//管理员编号
    @ApiModelProperty(name = "adminLoginAccount",value = "管理员登录账号",example = "13991267980")
    private String adminLoginAccount;//管理员登录账号（手机号码）
    @ApiModelProperty(name = "adminLoginPassword",value = "登录登录密码",example = "123456")
    private String adminLoginPassword;//登录登录密码（默认为手机号码后8位）
    @ApiModelProperty(name = "adminRole",value = "管理员角色",example = "管理员")
    private String adminRole;//管理员角色（超级管理员或普通管理员）
    @ApiModelProperty(name = "adminLastLoginTime",value = "最后登录时间")
    private Date adminLastLoginTime;//最后登录时间（2024年09月30日 15:30:40）
}

Result.java

package com.stringzhua.springboot_swagger02.pojo;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

//结果集
@Data
@NoArgsConstructor
@AllArgsConstructor
@ApiModel(value = "控制器方法返回值",description = "自定义结果集")
public class Result {

    @ApiModelProperty(name = "falge",value = "结果集状态",example = "true")
    private boolean falge;//状态
    @ApiModelProperty(name = "message",value = "提示信息",example = "查询成功")
    private String message;//提示信息
    @ApiModelProperty(name = "data",value = "返回数据")
    private Object data;//返回数据

}

Config层：

SwaggerConfig.java

package com.stringzhua.springboot_swagger02.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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;

import java.util.ArrayList;
/**
 * @Author Stringzhua
 * @Date 2024/9/30 11:41
 * description:
 */
@Configuration
public class SwaggerConfig {
    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.stringzhua.springboot_swagger02.controller"))//扫描路径
                .paths(PathSelectors.any())//定义哪些路径的接口需要生成文档
                .build();
    }

    //配置文档的信息
    private ApiInfo apiInfo() {
        Contact contact = new Contact("项目负责人","https://gitee.com/jun-0912/stringzhua-takeout","2785649457@qq.com");

        return new ApiInfo(
                "Swagger2.0文档学习技能点",//标题
                "学习配置Swagger",//描述
                "v3.0",//版本
                 "https://gitee.com/jun-0912",//组织链接
                contact,//联系人信息
                "Apach 2.0",//许可
                "https://gitee.com/jun-0912/sql-mother",//许可链接
                new ArrayList<>()//拓展
        );
    }
}

Controller层：

UserController.java

package com.stringzhua.springboot_swagger02.controller;

import com.stringzhua.springboot_swagger02.pojo.Admin;
import com.stringzhua.springboot_swagger02.pojo.Result;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.*;

import java.sql.Date;


/**
 * @Author Stringzhua
 * @Date 2024/9/30 11:41
 * description:
 */
@RestController
@RequestMapping("/user")
@Api(tags = "UserController|控制器1测试swagger", value = "/user")
public class UserController {
    /************************************修饰参数****************************************/
    @GetMapping(value = "/findByName")
    @ApiOperation(value = "根据用户名查询")
    public Result findByNamw(@RequestParam String userName) {
        boolean b = userName.equals("一猫人");
        return b == true ? new Result(true, "查询成功", "大熊猫本猫") : new Result(false, "查询失败", null);
    }

    @GetMapping(value = "/findByNameAndSex")
    @ApiOperation(value = "根据用户名与性别查询", notes = "我说这是一个描述你信吗？这是可以省略的")
    public Result findByNameAndSex(String userName, String Sex) {
        if (userName.equals("一猫人") && Sex.equals("女")) {
            return new Result(true, "查询成功", "大熊猫本猫");
        } else {
            return new Result(false, "查询失败", null);
        }
    }

    @GetMapping(value = "/findByAge/{age}")
    @ApiOperation(value = "根据用户的年龄查询", notes = "我说这是一个描述你信吗？这是可以省略的")
    public Result findByAge(@PathVariable("age") Integer userAge) {
        if (userAge > 18) {
            return new Result(true, "查询成功", "大熊猫本猫已成年");
        } else {
            return new Result(false, "查询失败", null);
        }
    }

    @PostMapping(value = "/saveAdmin1")
    @ApiOperation(value = "新增管理员信息1", notes = "我说这是一个描述你信吗？这是可以省略的")
    public Result saveAdmin1(Admin admin) {
        if (admin.getAdminId() > 10) {
            return new Result(true, "查询成功", "大熊猫本猫已成年");
        } else {
            return new Result(false, "查询失败", null);
        }
    }

    @PostMapping(value = "/saveAdmin2")
    @ApiOperation(value = "新增管理员信息2", notes = "我说这是一个描述你信吗？这是可以省略的")
    public Result saveAdmin2(@RequestBody Admin admin) {
        if (admin.getAdminId() > 10) {
            return new Result(true, "查询成功", "大熊猫本猫已成年");
        } else {
            return new Result(false, "查询失败", null);
        }
    }

    /************************************返回值****************************************/
    @DeleteMapping(value = "/deleteById/{id}")
    @ApiOperation(value = "根据用户编号删除信息", notes = "")
    public Admin deleteById(@PathVariable("id") Integer id) {
        return new Admin(1, "一猫人", "管理员", "普通管理员", new Date(System.currentTimeMillis()));
    }
}

启动类：

package com.stringzhua.springboot_swagger02;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@SpringBootApplication
@EnableSwagger2
public class SpringbootSwagger02Application {

    public static void main(String[] args) {
        SpringApplication.run(SpringbootSwagger02Application.class, args);
    }

}

配置文件：

spring.application.name=springboot_swagger02
spring.mvc.pathmatch.matching-strategy=ant_path_matcher

测试：

测试 /user/saveAdmin1
新增管理员信息1

点击try it out！

测试成功！