(三)ATP应用测试平台常用技术栈案例整合——springboot整合swagger3生成RESTful风格API接口测试服务

前言

在前后端分离项目中，为了方便前后端联调测试，我们可以在后端项目中引入swagger服务，将我们开发好的http接口暴露出来，供前端直接测试调用。减少了我们维护接口开发文档的过程，是的，没有错，swagger就是具有如此强大的功能。Swagge用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法、参数和模型紧密集成到服务器端的代码，允许 API 来始终保持同步。Swagger 让部署管理和使用功能强大的 API 从未如此简单。官话，你懂得。

正文

• pom配置中引入swagger3启动器

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter -->
<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-boot-starter</artifactId>
	<version>3.0.0</version>
</dependency>

• 添加swagger3配置

package com.yundi.atp.platform.config;

import io.swagger.annotations.ApiOperation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
/**
 * @Author: yanp
 * @Description:  swagger3配置
 * @Date: 2021/3/12 14:34
 * @Version: 1.0.0
 */
@EnableOpenApi
@Configuration
public class Swagger3Config {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("ATP应用测试平台")
                .description("编程也可以很快乐！！！")
                .contact(new Contact("yanp", "https://blog.csdn.net/yprufeng", "155190897@qq.com"))
                .version("1.0")
                .build();
    }
}

• 验证swagger

访问地址：http://ip:port/swagger-ui/index.html

结语

ok，到这里我们的springboot整合swagger3就结束，希望能对你有所帮助，我们下期见。。。