Swagger学习

2024-01-05 12:40:34

Swagger学习

Swagger简介

前后端分离

前后端分离时代（Vue + SpringBoot）：

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

产生一个问题：

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

解决方案：

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

Swagger

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

官网：https://swagger.io/

在项目中使用swagger需要springbox；

Swagger2
Swagger UI

SpringBoot集成Swagger

新建一个SpringBoot - web项目
导入相关依赖

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

编写一个Hello工程
配置Swagger ==> Config

package com.kuang.swagger.config;

import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

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

测试运行

配置Swagger

swagger的bean实例Docket；（在SwaggerConfig 类中添加）

@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("1LDK", "https://home.cnblogs.com/u/1ldk", "1LDK的联系方式");
        return new ApiInfo("1LDK的Api 文档",
                "Api 芜湖起飞",
                "v1.0",
                "https://home.cnblogs.com/u/1ldk",
                DEFAULT_CONTACT,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList());
    }
}

Swagger配置扫描接口

在SwaggerConfig 类中添加

//配置了swagger的Docket 的 bean 实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //.enable(false)//enable是否启动swagger，如果为Fals，则Swagger不能在浏览器访问
                .groupName("1LDK")//配置分组
                .select()
                //RequestHandlerSelectors:配置要扫描的接口的方式
                //basePackage:指定要扫描的包
                //any():扫描全部
                //none():不扫描
                //WithClassAnnotation:扫描类上的注解
               .apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))
                //paths()过滤什么路径的接口
                //.paths(PathSelectors.ant("/kuang/**"))
                .build();
    }

问题：我只希望我的Swagger在生产环境中使用，在发布的时候不使用？
解题思路：

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

解题步骤：
1.先在resources目录下创建两个properties文件，分别为application-dev.properties和application-pro.properties

接下来在application.properties文件中激活环境

spring.profiles.active=dev

在application-dev.properties中

server.port=8081

在application-pro.properties中

server.port=8082

2.接着上面的docket()，在方法中加入形参Environment获取application.properties中的设置的环境

    //配置了Swagger的Bean实例
    @Bean
    public Docket docket(Environment environment){

        //设置要显示的swagger环境
        Profiles profiles = Profiles.of("dev","test");

        //获取项目的环境:
        //通过environment.acceptsProfiles判断是否处在自己设定的环境当中
        boolean flag = environment.acceptsProfiles(profiles);
        
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //.enable(false)//enable是否启动swagger，如果为Fals，则Swagger不能在浏览器访问
                .groupName("1LDK")//配置分组
                .select()
                //RequestHandlerSelectors:配置要扫描的接口的方式
                //basePackage:指定要扫描的包
                //any():扫描全部
                //none():不扫描
                //WithClassAnnotation:扫描类上的注解
               .apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))
                //paths()过滤什么路径的接口
                //.paths(PathSelectors.ant("/kuang/**"))
                .build();
    }

3.在浏览器上请求http://localhost:8081/swagger-ui.html#/就可以访问Swagger了。

配置API文档的分组（常用）

配置分组.groupName()——（Docket()为链式编程结构，可以有多个方法）

Docket(DocumentationType.SWAGGER_2).groupName("1LDK")//配置分组

配置多个分组，多个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");
 }

Swagger中就会出现多个分组，分别为A，B和C。

在entity实体类中：

@ApiModel用来注释实体类；

@ApiModelProperty用来注释类中的成员变量；

package com.kuang.swagger.pojo;

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

@ApiModel("用户实体类")
public class User {

    @ApiModelProperty("用户名")
    public String username;
    @ApiModelProperty("密码")
    public String password;
}

在Controller控制类中：

@ApiOperation用来注释方法

@ApiParam用来注释请求的参数

package com.kuang.swagger.controller;

import com.kuang.swagger.pojo.User;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

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

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

    @ApiOperation("hello控制类")
    @GetMapping(value = "/hello2")
    public String hello2(@ApiParam("用户名") String username){
        return "hello " + username;
    }
    @ApiOperation("Post测试类")
    @GetMapping(value = "/post1")
    public User post1(@ApiParam("用户名") User user){
        return user;
    }
}

码农公寓

Swagger学习

Swagger简介

Swagger

SpringBoot集成Swagger

配置Swagger

Swagger配置扫描接口

配置API文档的分组（常用）

相关文章