1000字了解当下热门前后端团队沟通技术-Swagger

Swagger

学习目标：

• 了解Swagger的作用和概念
• 了解前后端分离
• 在SpringBoot中继承Swagger

Swagger简介

前后端分离

Vue + SpringBoot

后端时代：

前端只用管理静态页面，然后交付给后端，后端是主力

前后端分离时代：

后端：后端控制层、服务层、数据访问层[前端团队]

前端：前端控制层、视图层[后端团队]

前后端如何交互？API

前后端相对独立：松耦合

前后端甚至可以部署在不同的服务器上

产生一个问题：

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

解决方案：

• 首先指定一个schema[提纲]，实时更新最新API，降低集成的风险

• 早些年：制定word计划文档

• 前后端分离：

  • 前端测试后端接口：postman
  • 后端提供接口，需要实时更新最新的消息及改动！

Swagger

• 号称世界上最流行的API框架
• Restful Api文档在线生成工具—Api文档与Api定义同步更新
• 直接运行，可以在线测试Api接口
• 支持多种语言：Java、PHP

官网：https://swagger.io/

在项目中使用Swagger需要springfox；

• swagger2
• swagger-ui

SpringBoot集成Swagger

1、新建一个SpringBoot-web项目

2、导入相关依赖

<dependency>
    <groupId>io.springfoxgroupId>
    <artifactId>springfox-swagger2artifactId>
    <version>2.10.5version>
dependency>

<dependency>
    <groupId>io.springfoxgroupId>
    <artifactId>springfox-swagger-uiartifactId>
    <version>2.10.5version>
dependency>

3、编写一个Hello World！

4、配置Swagger–config

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

5、测试运行

配置Swagger

Swagger的bean实例Docket；

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

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

    //配置Swagger信息=apiInfo
    private ApiInfo apiInfo(){

        Contact contact = new Contact("于晓峰", "https://swagger.io/", "[email protected]");

        //作者信息
        return new ApiInfo("于晓峰的SwaggerApi文档",
                "但行好事，莫问前程",
                "v1.0","https://swagger.io/",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licences/LICENSE-2.0",
                new ArrayList());

    }

}

Swagger配置扫描接口

	@Bean
    //配置了Swagger的Docket的bean实例
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //RequestHandlerSelectors配置要扫描接口的方式
                //basePackage指定能扫描的包
                //withClassAnnotation()扫描类上的注解， 参数：注解的反射对象
                //withMethodAnnotation()扫描方法上的注解，
                .apis(RequestHandlerSelectors.basePackage("com.yu.swagger.controller"))
                //paths() 过滤什么路径，后面写什么路径就是过滤后剩下的路径
                .paths(PathSelectors.ant("/yu/*"))
                .build();
    }

配置是否启动Swagger

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

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

@Bean
    //配置了Swagger的Docket的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(flag)
                .select()
                //RequestHandlerSelectors配置要扫描接口的方式
                //basePackage指定能扫描的包
                //withClassAnnotation()扫描类上的注解， 参数：注解的反射对象
                //withMethodAnnotation()扫描方法上的注解，
                .apis(RequestHandlerSelectors.basePackage("com.yu.swagger.controller"))
                //paths() 过滤什么路径，后面写什么路径就是过滤后剩下的路径
                //.paths(PathSelectors.ant("/yu/*"))
                .build();
    }

配置API文档的分组

如何配置多个分组，创建多个Docket实例即可

实体类配置

package com.yu.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

package com.yu.swagger.controller;

import com.yu.swagger.pojo.User;
import io.swagger.annotations.ApiImplicitParam;
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("/hello")
    public String hello(){
        return "hello";
    }

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

    //Operation接口,不是放在类上，是放在方法上
    @ApiOperation("hello控制类")
    @GetMapping(value = "hello2")
    public String hello2(@ApiParam("用户名") String username){
        return "hello" + username;
    }

}

总结：

我们可以通过Swagger给一些比较难理解的属性或者接口，增加注释信息

接口文档实时更新

可以在线 测试

注意点：在正式发布的时候，关闭Swagger！！！出于安全考虑，并且还可以节省内存