多Model项目中，使用Swagger

Posted 2023-03-20

参考技术A 在实习接触第一个公司项目时，就已经见识过了项目中的Swagger注解。但对其并不了解，甚至是干什么的都不知道，今天对其学习了一下，在此简单记录一下Swagger在多Model项目中是如何整合使用的。

前后端分离开发模式中，api文档是最好的沟通方式。
Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。
1.及时性 (接口变更后，能够及时准确地通知相关前后端开发人员)
2.规范性 (并且保证接口的规范性，如接口的地址，请求方式，参数及响应格式和错误信息)
3.一致性 (接口信息一致，不会出现因开发人员拿到的文档版本不一致，而出现分歧)
4.可测性 (直接在接口文档上进行测试，以方便理解业务)

在日常写接口过程中，有些接口是无法直接在浏览器中进行测试，这时候我们就可以采用接口测试工具。
在我所了解的接口测试工具中，常用的应该就是postman和Swagger了。但是对于后端开发人员来说，更倾向于使用Swagger。

以我的多Model项目为例
在顶级父工程下创建common模块，并在其pom.xml文件中引入Swagger依赖

引入依赖后在common模块下再创建common_base模块并创建Swagger配置类

Swagger配置类：

这样Swagger大致就配置好了，接下来，就往接口模块进行引入。

在模块service模块引入service_base

在service的子模块——service_edu模块的启动类中添加 @ComponentScan 注解

这样，我们便可以对功能接口通过Swagger进行测试了。
我们也可以进行一些自定义设置

1.启动你的项目
2.访问路径 http://localhost :你的端口号/swagger-ui.html

3.进行测试

这里我用查询讲师列表为例

以上就是使用Swagger进行接口测试整合方法的简单介绍。

使用idea 创建springboot多模块项目

参考技术A 一、创建夫项目项目

打开idea ---》new project

点击next进入下一步

点击next

选择项目目录，点击完成

以下为创建好的项目

二、创建module

在swagger项目中修改pom文件

以下为新创建好的项目

启动swagger项目，可以启动成功

三、修改pom文件

删除所有pom文件中的

将swagger 中的parent改为最外部的项目

在最外部项目中引入module

在pom文件中添加