大家好,时隔一个月,我们又又又发布啦,本月的主题是:团队协作。
在开发模式是前后端协作的团队里,分享 API 文档信息会是前后端对接过程中重要的一环,我想在这次月报分享下我们工具推荐的开发流程。
知乎上有一个热门问题:后端人员先开发后给文档合理吗?
我认为不合理,换位思考了下在这种开发模式下的前端人员,对接的过程应该蛮痛苦,前端开发的能力和经验决定后续改动代码的痛苦程度。
涉及到多人共同协作完成一件事的时候,不应该把设计任务只交给其中的某一个人,应该先交流和沟通,将设计的流程前置,并用文档记录设计的过程和结果。
就像开发人员总会吐槽产品文档没写清楚一样,前端人员也会吐槽后端不给文档或者写不清楚,这个问题可以通过引入一个能协作设计并展示清晰的 API 信息的工具(明示 Eoapi)解决。
你可以考虑在 Eoapi 尝试采用以下简易的协作流程:
-
设计接口原型,写接口文档;
-
前后端同步写代码,根据文档对接;
-
在对接过程中获得的信息优化接口原型,重复过程。
更直观一些,两种协作流程的对比如图:
其实工作都是这些工作,但将设计的过程提前可以减少很多协作问题