JAVA SpringBoot-16：Swagger

最新推荐文章于 2023-12-07 00:38:14 发布

_淡若清风づ

最新推荐文章于 2023-12-07 00:38:14 发布

阅读量222

点赞数

分类专栏： # SpringBoot 文章标签： java swagger2 springboot

本文链接：https://blog.csdn.net/QQ1043051018/article/details/114293355

版权

SpringBoot 专栏收录该内容

19 篇文章 1 订阅

订阅专栏

Swagger

Swagger简介：

学习目标：

了解Swagger的作用和概念
了解前后端分离
在SpringBoot中集成Swagger

前后端分离：

Vue + SpringBoot

后端时代：

前端只用管理静态页面；
html==>后端，模板引擎
JSP==>后端是主力

前后端分离时代：

后端：后端控制层，服务层，数据访问层【后端团队】
前端：前端控制层【前端团队】
- 伪造后端数据，JSON。
- 不需要后端，前端工程也能启动起来
前后端如何交互？ ==》API
前后端相对独立，松耦合！
前后端甚至可以部署在不同的服务器上！

产生一个问题：

前后端集成联调，前端人员和后端人员无法做到“即使协商，尽早解决”，最终导致问题集中爆发！

解决方案：

首先指定Schema[计划的提纲]，实时更新最新API，降低集成的风险。
早些年：指定word计划文档。
前后端分离：
- 前端测试后端接口：Postman
- 后端提供接口，需要实时更新最新的消息及改动！

简介：

号称世界上最流行的Api框架
RestFul Api文档在线自动生成工具 => Api文档与API定义同步更新
直接运行，可以在线测试API接口
支持多种语言

官网：https://swagger.io/

在项目中使用

在项目中使用Swagger 需要 Springbox

Swagger2
UI

Springboot集成了Swagger

使用Swagger

要求：jdk 1.8 + 否则swagger2无法运行

步骤：

1、新建一个SpringBoot-web项目

在这里插入图片描述

2、添加Maven依赖

3.0.0的版本无法打开Swagger网页

<!-- 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>

3、编写HelloController，

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

@RestController
public class HelloController {

    @RequestMapping(value = "/hello")
    public String hello(){
        return "hello";
    }
}

4、使用Swagger

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

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

5、访问测试：

访问测试：http://localhost:8080/swagger-ui.html ，可以看到swagger的界面；
在这里插入图片描述

配置Swagger

1、配置Docket

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

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

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

    //配置Swagger的信息=apiInfo
    private ApiInfo apiInfo(){
        //作者信息
        Contact contact = new Contact("淡若清风", "https://blog.csdn.net/QQ1043051018", "1043051018@qq.com");
        return new ApiInfo(
                "清风的SwaggerApi文档",
                "你尽管努力，剩下的交给天意！",
                "v1.0",
                "https://blog.csdn.net/QQ1043051018",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList());
        }
    }

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

3、Docket 实例关联上 apiInfo()

    //配置了Swagger的Docket的实例
    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
    }

4、重启项目

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

配置扫描接口

1、扫描接口

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

    //配置了Swagger的Docket的实例
    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                // 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
                .select()
                //RequestHandlerSelectors,配置要扫描接口的方式
                //basePackage，指定具体要扫描的包
                .apis(RequestHandlerSelectors.basePackage("com.cy.swagger.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过滤,即这里只扫描请求以/cy开头的接口
      .paths(PathSelectors.ant("/cy/**"))

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

5、可选值

这里的可选值还有

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

配置Swagger开关

1、配置是否启用swagger，

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

//配置是否启用Swagger，如果是false，在浏览器将无法访问
.enable(false)

    //配置了Swagger的Docket的实例
    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //配置是否启用Swagger，如果是false，在浏览器将无法访问
                .enable(false)
                // 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
                .select()
                //RequestHandlerSelectors,配置要扫描接口的方式
                //basePackage，指定具体要扫描的包
                .apis(RequestHandlerSelectors.basePackage("com.cy.swagger.controller"))
                .build();
    }

在这里插入图片描述

2、思考如何动态配置？

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

判断是不是当前环境 flag=false
注入enable (flag)

分别创建application-dev.properties、application-prod.properties

分别表示开发阶段，和发布上线阶段

application.properties

spring.profiles.active=dev

application-dev.properties

server.port=8081

application-prod.properties

server.port=8081

思考：怎么在代码中实现这个功能？

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

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //配置是否启用Swagger，如果是false，在浏览器将无法访问
                .enable(flag)
                // 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
                .select()
                //RequestHandlerSelectors,配置要扫描接口的方式
                //basePackage，指定具体要扫描的包
                .apis(RequestHandlerSelectors.basePackage("com.cy.swagger.controller"))
                .build();
    }

3、dev配置文件

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

http://localhost:8081/swagger-ui.html#/basic-error-controller

配置API分组

1、配置分组

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

@Bean
public Docket docket(Environment environment) {
   return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
      .groupName("hello") // 配置分组
       // 省略配置....
}

2、重启项目查看分组

在这里插入图片描述

3、如何配置多个分组？

配置多个分组只需要配置多个docket即可：

    @Bean
    public Docket docket1(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("小李");
    }
    @Bean
    public Docket docket2(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("小红");
    }
    @Bean
    public Docket docket3(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("小明");
    }

4、重启项目查看即可

在这里插入图片描述

实体配置

1、新建一个实体类

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

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

2、请求接口的返回值

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

    //只要我们的接口中，返回值中存在实体类，就会被扫描到Swagger中
    @RequestMapping("/getUser")
    public User getUser(){
        return new User();
    }

3、重启查看测试

在这里插入图片描述

注：并不是因为@ApiModel这个注解让实体显示在这里了，而是只要出现在接口方法的返回值上的实体都会显示在这里，而@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

我们也可以给请求的接口配置一些注释

@ApiOperation("清风的接口")
@PostMapping("/cy")
@ResponseBody
public String qingfeng(@ApiParam("这个名字会被返回")String username){
   return username;
}

在这里插入图片描述

这样的话，可以给一些比较难理解的属性或者接口，增加一些配置信息，让人更容易阅读！

总结：

1.我们可以通过Swagger给一些比较难理解的属性或者接口，增加注释信息
2.接口文档实时更新
3.可以在线测试

【注意】在正式发布的时候，关闭Swagger！出于安全考虑，而且节省运行内存。

相较于传统的Postman或Curl方式测试接口，使用swagger简直就是傻瓜式操作，不需要额外说明文档(写得好本身就是文档)而且更不容易出错，只需要录入数据然后点击Execute，如果再配合自动化框架，可以说基本就不需要人为操作了。

Swagger是个优秀的工具，现在国内已经有很多的中小型互联网公司都在使用它，相较于传统的要先出Word接口文档再测试的方式，显然这样也更符合现在的快速迭代开发行情。当然了，提醒下大家在正式环境要记得关闭Swagger，一来出于安全考虑二来也可以节省运行时内存。

拓展：其他皮肤

我们可以导入不同的包实现不同的皮肤定义：
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-bootstrap-ui包 /doc.html-->
<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.9.1</version>
</dependency>

3、Layui-ui 访问 http://localhost:8080/docs.html
黑色

<!-- 引入swagger-ui-layer包 /docs.html-->
<dependency>
   <groupId>com.github.caspar-chen</groupId>
   <artifactId>swagger-ui-layer</artifactId>
   <version>1.1.3</version>
</dependency>

4、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>

_淡若清风づ

关注

0
点赞
踩
2

收藏

觉得还不错? 一键收藏
0
评论
JAVA SpringBoot-16：Swagger

SwaggerSwagger简介：学习目标：了解Swagger的作用和概念了解前后端分离在SpringBoot中集成Swagger前后端分离：Vue + SpringBoot后端时代：前端只用管理静态页面；html==>后端，模板引擎JSP==>后端是主力前后端分离时代：后端：后端控制层，服务层，数据访问层【后端团队】前端：前端控制层【前端团队】伪造后端数据，JSON。不需要后端，前端工程也能启动起来前后端如何交互？ ==》API前后
复制链接

扫一扫