Swagger（一）：SpringBoot整合Swagger及测试接口

2023-11-17 17:14:58

前言

最近用的Swagger一直是别人写好的，然后自己拿来直接用，虽然配置这个Swagger比较简单，但是还是想写一篇比较详细的文章，人的大脑的记忆力都是有限的，说不定什么时候自己就突然忘了，这样于人于己都很方便，话不多说，下面开码。

首先还是pom文件

		<!-- 引入swagger的两个依赖 -->
        <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>

SwaggerConfig配置类

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.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                //标题
                .title("My-Swagger")
                //描述
                .description("欢迎来访问我的Swagger")
                //作者信息
                .contact(new Contact("Body","https://blog.csdn.net/weiaikaixuan","某某邮箱.com"))
                //版本
                .version("1.0")
                .build();
    }

}

Controller层


@RestController
@RequestMapping(value = "user")
@Api(value = "user",tags = "用户接口")
public class UserController {

    @Autowired
    private UserService userService;
    
    @RequestMapping(value = "getUser",method = RequestMethod.GET)
    @ApiOperation(value = "根据id获取用户信息")
    private User getUser(
            @ApiParam(value = "用户id",required = true)
            @RequestParam(value = "id") Long id){
        return userService.findById(id);
    }

}

剩余其他的获取用户的逻辑可以自己去整理出来，这里就不贴出来了

访问Swagger接口文档

依赖和配置文件都弄好以后启动项目，在浏览器*问http://localhost:8080/swagger-ui.html

打开之后如下图：

在这里就可以看到我们在SwaggerConfig配置类中的定义的ApiInfo中的信息，说明我们配置的Swagger成功了，然后接下来进行接口的测试，我这里就只测查询一个的数据了，其它的可以慢慢测

打开用户接口

打开用户接口之后点击右上角的Try it out

输入用户的id

输入完用户id之后点击Execute

获取到用户id为1的数据

成功获取到数据

看一下控制台输出的SQL语句

可以看到确实有一条查询的SQL语句
注：我的这个项目还整合了Spring Data JPA，所以控制台有SQL输出语句
我SpringBoot整合Spring Data JPA超详细链接：SpringBoot整合JPA

看这条数据是否是从数据库查出

可以看到数据库确实有这条数据

总结

SpringBoot整合Swagger主要就两个地方，引入Swagger的依赖和写一个SwaggerConfig的配置类，配置也很简单

码农公寓

前言