【三招】如何高效率的开发出高质量的REST API?

于谦老师相声说得好,他有厉害的三招啊,吸烟、喝酒、烫头!html

开个玩笑哈。在咱们软件工程师的世界里,如何切实保障代码质量,开发出“好”的接口,不给领导和同事添麻烦?浏览器


有多种方法和API调试工具可用,也总结【三招】:单元测试、Swagger文档、Postman调试:网络

1,单元测试:上文介绍过Spring框架提供了Mock功能辅助HTTP测试,单元测试覆盖主要功能函数,而且和自动构建系统集成,能及时发现功能缺陷和代码改动带来的bug,保证项目质量。框架

视频课:【1小时进阶SpringBoot网络开发】REST接口 + HttpClient开发实战ide


2,Swagger接口文档和调用:Swagger框架定义了完整的REST接口文档规范,提供了强大的页面测试功能,可以调试和可视化API接口服务,而且将文档融合到代码中,让维护文档和修改代码整合为一体,使得修改代码逻辑的同时方便的修改文档说明。函数

博客:Spring集成Swagger,3步自动生成API文档工具

浏览器打开http://localhost:8011/swagger-ui.html,展开接口信息,选择文件而后”Try it ou!”
单元测试

image.png

3,Postman是一个经常使用的API调试工具,支持各类请求方式和配置环境变量,并对返回结果进行测试校验,支持批量自动化运行,能够和自动构建系统集成,并且能够导入导出JSON文件,高效团队协做。测试

视频课:【1小时掌握8个使用技巧】赋能API测试和集成,Postman能够这样用?ui

image.png