接口文档和接口开发的关系

  在前后端分离的敏捷开发的背景下,产品经理做好了需求文档和原型,前后端如何根据需求文档和原型并行开发?前端等着后端开发好接口再给 swagger 接口文档已经成了过去式,这时候需要后端人员通过 ShowDoc 先写一份接口文档,然后前后端各自开发各自的,等到开发完成之后,只需要对接下就可以了。

  前期的接口文档不应和后端的代码耦合在一起,swagger 文档和需求文档也不太一致,写在 controller 中返回的模拟数据既耗费时间,而且接口写好之后又不便于追溯改了啥。所以,开发之前使用 ShowDoc 的接口文档,服务端开发时用 swagger 进行接口的调试,开发完成之后,在前后端对接时就可以给前端看 swagger 文档了。

posted @ 2022-08-10 11:48  heroljy  阅读(208)  评论(0编辑  收藏  举报