Postman
Postman 几乎是后端和测试同学人手一个的利器。它最初作为 Chrome 插件出现,用于临时的 HTTP 请求调试,但现在功能已经非常完善。最实用的特性在于它能将调试过的请求保存到 Collection(集合)中。这份集合不仅是一份简单的接口文档,还支持在线测试和团队协作。
对于 QA 来说,最大的价值在于'测试即文档'。用 Postman 跑一遍接口,文档自然就更新好了,维护成本极低。只要使用同一账号登录,团队成员之间就能实现同步和分享,大大减少了沟通文档版本不一致的麻烦。
Swagger
如果说 Postman 偏向于外部调用,那 Swagger 更侧重于服务内部的契约定义。它是一个完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。在前后端分离的项目中,Swagger 能解决很多协作痛点。
它的核心能力主要体现在四个方面:
- 自动生成文档:直接嵌入项目,开发时只需编写注释,即可自动生成接口文档,无需手动维护 Word 或 Wiki。
- 编辑器支持:内置 Swagger Editor,支持 YAML 格式的 API 编辑,可导出标准的 yaml 或 json 文件。
- 可视化展示:通过 Swagger UI,将编辑好的接口文档渲染成友好的 HTML 页面,方便前端查阅参数。
- 代码生成:支持根据定义的接口规范,导出多种语言的服务端或客户端代码骨架。

