在项目开发中,web项目的前后端分离开发,APP开发,需要由前后端工程师共同定义接口,编写接口文档,之后大家都根据这个接口文档进行开发,到项目结束前都要一直维护。
接口文档分为四部分:请求方法type、请求路径url、请求参数、返回参数
书写接口文档最好在线书写,这样前后端的都可以进行阅读。并且可以通过权限,设置每个人在书写文档时候的权限。在线接口文档链接地址:https://www.showdoc.cc
来一波流程图:
一、注册登录
二、建立 文件夹及文件
三、书写接口
四、书写接口