【学习笔记】：SpringBoot集成Swagger2

最新推荐文章于 2024-08-17 12:33:42 发布

@zewi

最新推荐文章于 2024-08-17 12:33:42 发布

阅读量199

点赞数

文章标签： java spring boot

本文链接：https://blog.csdn.net/qq_42439118/article/details/107791166

版权

一、认识Swagger

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。是当前最好用的Restful API文档生成的开源项目。
在这里插入图片描述

官网：https://swagger.io/
直接运行，在线测试API
支持多种语言（如：Java，PHP等）
Restful Api 文档在线自动生成器（ API 文档与API 定义同步更新）

二、SpringBoot集成Swagger

1、新建springboot-web项目
使用swagger,需要导入两个jar包

springfox-swagger2
springfox-swagger-ui

也可以使用maven的方式添加依赖：

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

2、编写一个配置类-SwaggerConfig。

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

}

3、启动Spring Boot程序，访问测试：http://localhost:8080/swagger-ui.html ，可以看到如下swagger的界面。
在这里插入图片描述

配置Swagger

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

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

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

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

3、Docket 实例关联上我们定义的 apiInfo()；

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

4、重启项目，访问测试 http://localhost:8080/swagger-ui.html 看下效果；
在这里插入图片描述

配置扫描接口

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

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

2、重启项目测试，由于我们配置根据包的路径扫描接口，所以我们只能看到一个类;
在这里插入图片描述

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

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) // 根据包路径扫描接口

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

  // 配置如何通过path过滤,即这里只扫描请求以/zewi开头的接口
      .paths(PathSelectors.ant("/zewi/**"))

可选值:

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

配置Swagger开关

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

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

@Bean
public Docket docket(Environment environment) {
   // 设置要显示swagger的环境
   Profiles of = Profiles.of("dev", "test");
   // 判断当前是否处于该环境
   // 通过 enable() 接收此参数判断是否要显示
   boolean b = environment.acceptsProfiles(of);
   
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .enable(b) //配置是否启用Swagger，如果是false，在浏览器将无法访问
      .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.zewi.controller"))
       // 配置如何通过path过滤,即这里只扫描请求以/zewi开头的接口
      .paths(PathSelectors.ant("/zewi/**"))
      .build();
}

在项目中yml增加dev、pro多个配置文件查看效果！
在这里插入图片描述

配置API分组

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

 // 配置分组
    @Bean
public Docket docket1(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("hello");
}

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、新建一个实体类

@ApiModel为类添加注释
@ApiModelProperty为类属性添加注释

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

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

@RequestMapping("/getUser")
public User getUser(){
   return new User();
}

3、重启查看测试

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

常用注解

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

Swagger注解	简单说明
@Api(tags = “xxx模块说明”)	作用在模块类上
@ApiOperation(“xxx接口说明”)	作用在接口方法上
@ApiModel(“xxxPOJO说明”)	作用在模型类上：如VO、BO
@ApiModelProperty(value = “xxx属性说明”,hidden = true)	作用在类方法和属性上，hidden设置为true可以隐藏该属性
@ApiParam(“xxx参数说明”)	作用在参数、方法和字段上，类似@ApiModelProperty
@ApiError	发生错误返回的信息
@ApiResponses	用于表示一组响应
@ApiResponse	用在@ApiResponses中，一般用于表达一个错误的响应信息（code：数字，例如400 l message：信息，例如"请求参数没填好"lresponse：抛出异常的类）
@ApiImplicitParam	用来注解来给方法入参增加说明。
@ApiImplicitParams	用在方法上包含一组参数说明

! @ApiImplicitParam的参数说明：

paramType：指定参数放在哪个地方
【header：请求参数放置于Request Header，使用@RequestHeader获取。
query：请求参数放置于请求地址，使用@RequestParam获取。
path：（用于restful接口）–>请求参数的获取：@PathVariable
body：（不常用）
form（不常用）】
name：参数名
dataType：参数类型
required：参数是否必须传
value：说明参数的意思
defaultValue：参数的默认值


@Controller
@RequestMapping("/user")
@Api(value = "UserController|一个用来测试swagger注解的控制器")
public class UserController {
    
    @ResponseBody
    @RequestMapping(value ="/getUserName", method= RequestMethod.GET)
    @ApiOperation(value="根据用户编号获取用户姓名", notes="test: 仅1和2有正确返回")
    @ApiImplicitParam(paramType="query", name = "userNumber", value = "用户编号", required = true, dataType = "Integer")
    public String getUserName(@RequestParam Integer userNumber){
        if(userNumber == 1){
            return "张三";
        }
        else if(userNumber == 2){
            return "李四";
        }
        else{
            return "未知";
        }
    }
    }

注意
1、 paramType会直接影响程序的运行期，如果paramType与方法参数获取使用的注解不一致，会直接影响到参数的接收。
2、在后台采用对象接收参数时，Swagger自带的工具采用的是JSON传参，测试时需要在参数上加入@RequestBody,正常运行采用form或URL提交时候请删除。

Swagger界面

除了swagger官方界面，可以导入其他前端界面的依赖实现不同的皮肤定义。
1、bootstrap-ui 访问 http://localhost:8080/doc.html

<!-- 引入swagger-bootstrap-ui包 /doc.html-->
<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.9.1</version>
</dependency>

在这里插入图片描述

2、mg-ui 访问 http://localhost:8080/document.html

<!-- 引入swagger-ui-layer包 /document.html-->
<dependency>
   <groupId>com.zyplayer</groupId>
   <artifactId>swagger-mg-ui</artifactId>
   <version>1.0.6</version>
</dependency>

在这里插入图片描述

Swagger的好处

1、实现了后台和前端交互的实时性，可以随时对更改的接口文档进行查看，防止出现调用接口错误。

总结文章

配置注释可以给一些比较难理解的属性或者接口，增加一些配置信息，让人更容易阅读！相较于传统的Postman或Curl方式测试接口，使用swagger更方便操作，不需要额外说明文档(自动生成)而且更不容易出错，只需要录入数据然后点击Execute即可。在正式环境要记得关闭Swagger（出于安全考虑和节省运行时内存）