项目开发中,以controller层为界,负责好看的前段和负责数据处理的后端经常是并行进行的,因此前端开发团队和后端开发团队之间的沟通十分重要。同时这也是一个容易影响项目进度的地方。如前端经常抱怨后端给的接口文档与实际情况不一致。后端又觉得编写及维护接口文档会耗费不少精力,经常来不及更新。
通过命名规则等 项目规范 来解决这样的问题。但是实际情况中,笔误等原因会导致有些明明不那么规范。
Swagger可以解决上面的这个问题。
Swagger可以
1)为后端开发提供接近前段界面的 界面,在前段尚未完工的情况下 进行调试。
2)为前端提供后端的各个接口(包括参数的说明)。
3)由于只要后端在开发代码时做好注释,Swagger会自动生成解释文档,可以有效地增加前端和后端的沟通效率。