Swagger让前后端不再打架

最新推荐文章于 2024-01-15 02:29:15 发布

白给的阿威

最新推荐文章于 2024-01-15 02:29:15 发布

阅读量530

点赞数 2

分类专栏：后端笔记文章标签： java

本文链接：https://blog.csdn.net/qwe780310/article/details/107569100

版权

后端笔记专栏收录该内容

8 篇文章 0 订阅

订阅专栏

Swagger

学习目标：

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

1、Swagger简介

1、前后端分离时代

后端：后端控制访问层、服务层、数据访问层【后端团队】
前端：前端控制层、视图层【前端团队】
现在前端可以伪造后端数据，json，本应该是一个url去请求后端的数据，直接写成死的json数据了，不用后端就可以跑起来
前后端如何交互---》》后端给前端一个API接口，前端去调就行
前后端相对独立，松耦合；
前后端项目甚至可以部署在不同的服务器上

2、产生的问题

前后端集成联调，前端人员和后端人员无法做到，及时协商，所以需要尽早解决，不解决就容易导致问题的集中爆发

3、解决方案

首先指定一个schema【计划的提纲】，实时更新后端的最新的API，降低集成的风险
早些年：制定word文档；
前后端分离：

前端测试后端接口：postman

后端提供接口，需要实时更新最新的消息及改动

4、为了解决上述问题

Swagger应运而生
号称世界上最流行的API框架
也叫RestFul API 文档自动在线生成工具-》API文档和API定义同步更新
可以直接运行，在线测试API接口
支持多种语言 JAVA 、PHP
官网：https://swagger.io/

2、SpringBoot集成Swagger

SpringBoot集成Swagger => springfox，两个jar包

Springfox-swagger2
swagger-springmvc

1、使用Swagger

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

步骤：

1、新建一个SpringBoot-web项目

2、添加Maven依赖

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

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

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

 @Configuration
 //==@component 注册组件
 //开启swagger2
 @EnableSwagger2
 public class SwaggerConfig {
 
 }

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

2、配置swagger

1、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("wei", "www.baidu.com", "929936750@qq.com");
 
     return new ApiInfo(
         "wei的swagger日记",//对应是swagger界面大标题
         "但行好事，莫问前程",//swagger的描述
         "v1.0",
         "http://www.baidu.com",//服务URL术语
         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.SWAGGER_2).apiInfo(apiInfo());
 }

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

3、swagger配置扫描接口

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

 @Bean
 public Docket docket() {
    return new Docket(DocumentationType.SWAGGER_2)
       .apiInfo(apiInfo())
       .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
       .apis(RequestHandlerSelectors.basePackage("com.wei.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、除此之外，我们还可以配置接口扫描过滤：

 return new Docket(DocumentationType.SWAGGER_2)
                 .apiInfo(apiInfo())
                 //enable:是否启动swagger 为false 则不能访问swagger的页面
                 .enable(flag)
                 .select()
                 //RequestHandlerSelectors 配置要扫描接口的方式
                 //basePackage : 指定扫描的包
                 //any：扫描全部
                 //none：都不扫描
                 //withClassAnnotation:扫描类上的注解  参数需要一个注解的Class
                 //withMethodAnnotation：扫描方法上的注解
                 .apis(RequestHandlerSelectors.basePackage("com.wei.controller"))
                 //path()过滤什么路径
                 //过滤user下面的所有请求
                 //.paths(PathSelectors.ant("/user/**"))
                 .build();

5、这里的可选值还有

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

4、配置Swagger开关

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

 @Bean
 public Docket docket() {
    return new Docket(DocumentationType.SWAGGER_2)
       .apiInfo(apiInfo())
       .enable(false) //配置是否启用Swagger，如果是false，在浏览器将无法访问
       .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
       .apis(RequestHandlerSelectors.basePackage("com.wei.swagger.controller"))
        // 配置如何通过path过滤,即这里只扫描请求以/wei开头的接口
       .paths(PathSelectors.ant("/wei/**"))
       .build();
 }

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

  //配置了Swagger 的 Docket 的Bean实例
     @Bean
     public Docket getDocket(Environment environment){
 
         //设置要显示的swagger环境  只有生成环境对应起来才会返回true  可以访问Swagger
         Profiles profiles = Profiles.of("dev","test");//可变长String
         //获取项目的环境：
         //通过environment.acceptsProfiles判断是否处在自己设定的环境中
         boolean flag = environment.acceptsProfiles(profiles);
 
 
         return new Docket(DocumentationType.SWAGGER_2)
                 .apiInfo(apiInfo())
                 //enable:是否启动swagger 为false 则不能访问swagger的页面
                 .enable(flag)
                 .select()
                 //RequestHandlerSelectors 配置要扫描接口的方式
                 //basePackage : 指定扫描的包
                 //any：扫描全部
                 //none：都不扫描
                 //withClassAnnotation:扫描类上的注解  参数需要一个注解的Class
                 //withMethodAnnotation：扫描方法上的注解
                 .apis(RequestHandlerSelectors.basePackage("com.wei.controller"))
                 //path()过滤什么路径
                 //过滤user下面的所有请求
                 //.paths(PathSelectors.ant("/user/**"))
                 .build();
     }
 
     //配置swagger信息=apiinfo
     private ApiInfo apiInfo(){
 
         //作者信息
         Contact contact = new Contact("wei", "www.baidu.com", "929936750@qq.com");
 
         return new ApiInfo(
                 "wei的swagger日记",//对应是swagger界面大标题
                 "但行好事，莫问前程",//swagger的描述
                 "v1.0",
                 "http://www.baidu.com",//服务URL术语
                 contact,
                 "Apache 2.0",
                 "http://www.apache.org/licenses/LICENSE-2.0",
                 new ArrayList()
         );
     }

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

application-dev.properties

 #更改端口配置
 server.port=8081

application-pro.properties

 #更改端口配置
 server.port=8082

application.properties

 #使用生产环境
 spring.profiles.active=dev
 #将生产环境设置为properties-dev

5、配置API分组

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

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

2、重启项目查看分组

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

 //每一个Docket对象都管理着不同的请求。
 //在合作开发的过程中，每个类的不同的Docket都会被Spring托管  每个人只需要管理好自己的Docket即可
 @Bean
 public Docket docket1(){
     return new Docket(DocumentationType.SWAGGER_2).groupName("weishenA");
 }
 @Bean
 public Docket docket2(){
     return new Docket(DocumentationType.SWAGGER_2).groupName("weishenB");
 }@Bean
 public Docket docket3(){
     return new Docket(DocumentationType.SWAGGER_2).groupName("weishenC");
 }

4、重启项目查看即可

6、实体类配置

1、新建一个实体类

package com.wei.entity;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

//给实体类一个文档注释
//@Api("同等注释") 和apiModel
@ApiModel("用户实体类")
public class User {
    //给字段一个注释
    @ApiModelProperty("用户名")
    private String username;
    @ApiModelProperty("密码")
    private String password;

    public User() {
    }

    public User(String username, String password) {
        this.username = username;
        this.password = password;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }
}

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

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

3、重启查看测试

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

7、常用注解

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

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

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

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

//operation接口  不是放在类上的
// 内容就是一个给接口的注释
//@ApiParam("用户名") 给参数注释 说明参数的干嘛的
@GetMapping("/user")
@ApiOperation("hello2控制器")
public String  hello2(@ApiParam("用户名") String username){
    return "hello"+username;
}

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

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

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