SpringBoot整合Swagger，方便后端测试

Posted 2023-03-09

参考技术A 用Swagger能够在后端写好接口后进行测试，测试过程非常方便。

Swagger 是一个用于生成、描述和调用 RESTful 接口的 Web 服务。通俗的来讲，Swagger 就是将项目中所有（想要暴露的）接口展现在页面上，并且可以进行接口调用和测试的服务。

Swagger 官网地址：https://swagger.io/

从上述 Swagger 定义我们不难看出 Swagger 有以下 3 个重要的作用：

swagger2是：http://localhost:8080/swagger-ui.html

swagger3是：http://localhost:8080/swagger-ui/index.html

注意观察：swagger2的注解基本都是以API开头的，以此来判断注解是否为swagger2注解。同样,swagger3也有类似特性。

swagger2必须要引入springfox-swagger2、springfox-swagger-ui这两个依赖

lombok插件要引入lombok依赖

这样swagger就配置完成了，接下来是使用方式

在entity实体类上使用

在controller实体类上使用

访问地址

http://localhost:8080/swagger-ui.html

图示

输入内容后，点击try it out ，即可得到结果

swagger2使用起来非常方便，引入依赖，创建一个配置类就能直接用了，用postman还得手动创建每个访问链接，非常麻烦，swagger2算是挺方便了。

它与swagger2的差异在于

配置文件上添加的注解是@EnableOpenApi而swagger2是@EnableSwagger2 访问地址http://localhost:8080/swagger-ui/index.html 而swagger2是http://localhost:8080/swagger-ui.html pom引入的文件只有一个 springfox-boot-starter 而swagger2有两个springfox-swagger2 springfox-swagger-ui

entity实体类

和swagger2对比没有变化

controller

appication.properties

访问网址：http://localhost:8080/swagger-ui/index.html

可以看到,ui变大变好看了点