SpringBoot集成Swagger

这是我参与新手入门的第一篇文章

前言

在Web后端人员开发接口时，需要对接口进行测试，这是我们可以使用到今天要提到的工具Swagger。

Swagger是什么？

Swagger官网网址：API Documentation & Design Tools for Teams | Swagger

进入官网我们就可以看见官方对Swagger的简介

Simplify API development for users, teams, and enterprises with the Swagger open source and professional toolset. Find out how Swagger can help you design and document your APIs at scale.

简言之就是帮助用户简化API开发的工具，它可以将API可视化从而方便开发人员进行设计于调试。

由于笔者主要使用Java，故今天想要介绍的是在SpringBoot中如何集成Swagger。

新建SpringBoot项目并引入依赖

将Swagger的依赖引入SpringBoot项目

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

项目结构如图

新建Swagger配置类

Swagger配置类位置如上图

Swagger配置类用于配置Swagger扫描的接口、作者的信息

配置类代码如下

/**
 * @author xunle
 */
@EnableSwagger2
@Configuration
public class SwaggerConfig {
    /**
     * 配置Swagger的信息
     */
    private ApiInfo getApiInfo() {
        //作者信息
        Contact contact = new Contact("xunle","https://xunle1.github.io/","1601315809@qq.com");
        return new ApiInfoBuilder()
                //标题
                .title("Swagger Test")
                //描述信息
                .description("SpringBoot集成Swagger")
                //版本号
                .version("v1.0")
                //作者信息
                .contact(contact)
                .build();
    }

    /**
     * 用于配置Swagger扫描接口
     */
    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(getApiInfo())
                .select()
                //apis用于配置扫描哪些接口
                .apis(RequestHandlerSelectors.basePackage("com.example.swagger.controller"))
                //paths用于配置路径选择
                .paths(PathSelectors.ant("/hello/**"))
                .build()
                //是否开启Swagger
                .enable(true);
    }
}

新建Controller

Controller位置如上图

Controller类中定义接口

/**
 * @author xunle
 */
//Api 类信息
@Api(tags = "Swagger测试Controller")
@Controller
public class SwaggerController {
    //ApiOperation 方法描述
    @ApiOperation("Swagger测试Get方法")
    @ResponseBody
    @GetMapping("/hello/test")
    public String test() {
        return "Swagger测试";
    }
    
    @ApiOperation("Swagger是否扫描路径")
    @ResponseBody
    @GetMapping("/hi/test")
    public String testPathSelector() {
        return "selected!";
    }
}