Swagger接口文档和Postman测试

本文为UP主《信息系统开发综合实践》课程教学视频配套教学笔记,请对照视频操作。

传送门:

本系列课程,步骤详尽,所有代码都由UP主亲自编写测试,面向刚学完Java课程的开发小白。课程采用市场主流开发技术,保姆级实践操作教学。

感谢一键三连!  

1 Swagger简介

Swagger的意思是大摇大摆地走。很嚣张、很拽!

对于前后端分离开发,后端程序员最重要的协作工作,就是编写接口文档提供给前端工程师。

对于早期的后端开发者,编写及维护接口文档会耗费不少精力。由于更新不及时,非常容易造成前端工作滞后、前端代码错误的情况,前后端工程师互相推诿埋怨。

所有这一切,自从有了Swagger变得不复存在。

Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。话不多说,马上演示SpringBoot如何集成Swagger。

2 SpringBoot集成Swagger

pox.xml中添加依赖。

需要注意的是如果SpringBoot版本大于2.5.6,因为SpringMvc和Swagger路径匹配策略不同,会造成程序启动会报错。笔记项目SprinBoot为2.7.0>2.5.6。解决办法是在application.properties中加入配置修改SpringMvc匹配策略。

server.port=8081

spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER

然后,额…….。对不起,没有然后了。

运行项目,浏览器输入:http://localhost:8081/swagger-ui/index.html

呵呵, 太拽了!

为了让接口调用者明白接口用途,可添加接口方法说明。在接口上加上@ApiOperation(“接口描述”)注解。

这样接口文档显示中文说明,方便前端工程师了解该接口用途。

 接口测试

可直接在接口文档中对接口进行测试。点击Try it out。

点击Execute。

然后查看接口返回数据。

3 postman接口测试工具

虽然Swagger本身可以进行测试,但Swagger文档侧重于提供接口文档。

更强大和方便的测试工具是postman,实际开发项目应用最广泛。

3.1 postman测试接口

从postman官方网站https://www.postman.com/ 下载安装。

运行postman,点击+,然后输入接口地址,回车

3.2 postman导入swagger

此外,Postman还可以将swagger接口导入。

第一步:复制Swagger接口地址,如http://localhost:8081/v3/api-docs

第二步:在postman中导入链接

点击import—选择Link—输入地址

第三步:测试接口

将Collection改名为NextGenPos Api。然后点击接口,回车。

是不是非常方便?

此外,我们还可将所有测试案例生成在线的mock-server,这样不运行后端程序,前端也能调用接口了。

因为目前都是简单的get请求,同学可能觉得posman并没有强大方便多少。但后面我们会使用post或者put请求,需要提交数据,就体现出来了。

4 SpringBoot热部署

前面我们发现,我们每次修改代码后,如果想进行测试,都需要进行重启项目使改动生效,非常麻烦。操作。

Spring为开发者提供了一个名为spring-boot-devtools的模块来使Spring Boot应用支持热部署,提高开发者的开发效率,无需手动重启Spring Boot应用。

在pom.xml中添加依赖坐标。<optional></optional>

接下来,需要设置打开自动构建项目。设置——构建——编译器

接下来设置允许正在运行的程序能自动启动。

设置完成后,热部署就生效了。

每次修改完代码进行保存,项目会进行自动进行重新启动。

当然,有的时候我们并不希望每次修改保存项目就进行重启。

因此,可以在application.properties中加入以下配置。将enable设置为false就取消热部署。设置为true,就启动热部署,灵活满足开发需要。

spring.devtools.restart.enabled=false

我们的课程来到了第一个小的里程碑。大家可以骄傲而低调地宣布,我写SpringBoot程序了。

NextGenPos项目后端已经能提供简单数据并经过测试。当然,我们希望不仅仅是控制台或是测试工具输出数据。我们更希望前端页面能够显示数据。

接下来后端项目将暂停一段时间,课程将转向前端Vue,掌握前端Vue的入门技巧。

资源下载: