Swagger笔记

Posted 2022-12-10 眰恦ღ

学习目标：

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

Swagger简介

前后端分离

Vue + SpringBoot

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

前后端分离时代：

• 后端：后端控制层、服务层、数据访问层
• 前端：前端控制层、视图层
  • 伪造后端数据，json。已经存在了，不需要后端，前端依旧能够跑起来
• 前后端如何交互？===>API
• 前后端相对独立，松耦合；
• 前后端甚至可以部署在不同的服务器上

产生一个问题：

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

解决方案：

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

Swagger

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

官网：https://swagger.io/

在项目使用Swagger需要springbox;

• swagger2
• ui

SpringBoot集成Swagger

1、新建一个SpringBoot —Web项目

2、导入依赖

<!-- 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、编写一个Hello工程

@RestController
public class HelloController 

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

4、配置Swagger==>Config

@Configuration
@EnableSwagger2     //开启Swagger2
public class SwaggerConfig 
    

5、测试运行：http://localhost:8080/swagger-ui.html

配置Swagger信息

Swagger的bean实例 Docket;

@Configuration
@EnableSwagger2     //开启Swagger2
public class SwaggerConfig 
    //配置了Swagger的Docket的bean实例
    @Bean
    public Docket docket()
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
    
    //配置Swagger信息=apiInfo
    private ApiInfo apiInfo()
        Contact contact = new Contact("", "", "");
        return new ApiInfo(
                "Slow的Swagger文档",
                "即使再小的帆也能远航",
                "1.0",
                "https://blog.csdn.net/weixin_45277249?spm=1001.2101.3001.5343",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList());
    

配置扫描接口及开关

Docket.select();

@Bean
public Docket docket()
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        //RequestHandlerSelectors，配置要扫描接口的方式
        //basePackage:指定要扫描的包
        //any():扫描全部
        //none():什么都不扫描
        //withClassAnnotation:扫描类上的注解，参数是一个注解的反射对象
        //withMethodAnnotation:扫描方法上的注解
        .apis(RequestHandlerSelectors.basePackage("com.cgz.controller"))
        //paths() 过滤什么路径
        .paths(PathSelectors.ant("/cgz/**"))
        .build();

配置是否启动Swagger

@Bean
    public Docket docket()
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(false)  //enable是否启动Swwagger，如果为false，则Swagger不能再浏览器中访问 
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.cgz.controller"))
//                .paths(PathSelectors.ant("/cgz/**"))
                .build();
    

我只希望我的Swagger在生产环境中使用，在发布时候不使用

• 判断是不是生产环境 flag=false
• 注入enable()

1、新建一个application-dev.properties

server.port=8081

2、新建一个application-pro.properties

server.port=8082

3、在application.properties中切换环境

spring.profiles.active=dev

@Bean
public Docket docket(Environment environment)
    //设置要显示的Swagger环境
    Profiles profiles = Profiles.of("dev","test");
    //通过enviroment.acceptsProfiles判断是否处在自己设定的环境当中
    boolean flag = environment.acceptsProfiles(profiles);
    System.out.println(flag);
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .enable(flag)  //enable()是否启动Swwagger，如果为false，则Swagger不能再浏览器中访问
        .select()
        .apis(RequestHandlerSelectors.basePackage("com.cgz.controller"))
        //                .paths(PathSelectors.ant("/cgz/**"))
        .build();

如果环境是dev就会开启Swagger，如果是pro则不会

配置API文档的分组

.groupName("Slow")

如何配置多个分组；多个Docket实例即可

@Bean
public Docket docket1()
    return new Docket(DocumentationType.SWAGGER_2).groupName("A");

@Bean
public Docket docket2()
    return new Docket(DocumentationType.SWAGGER_2).groupName("B");

@Bean
public Docket docket3()
    return new Docket(DocumentationType.SWAGGER_2).groupName("C");

实体类配置

新建一个实体类User

//@Api("注释")
@ApiModel("用户实体类")
public class User 
    @ApiModelProperty("用户名")
    public String username;
    @ApiModelProperty("密码")
    public String password;

Controller中

@ApiOperation("Hello方法")
//只要我们的接口中，返回值中存在实体类，他就会扫描到Swagger中
@PostMapping(value = "/user")
public User user()
    return new User();

Api注解的使用

//这个注解不是放在类上的，是方法上的
@ApiOperation("Hello方法")
@GetMapping(value = "/hello2")
public String hello2()
    return "hello";

@ApiOperation("Post测试")
@PostMapping(value = "/post")
public User post(@ApiParam("用户名") User user)
    int i = 5/0;
    return user;

总结

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