多年的IT经验告诉你:不合理,而且会造成工期的延误,不利于整体项目的推进。
接口
它是基于超文本传输协议(HTTP)之上而确定的一组约束和属性,是一种设计提供万维网络服务的软件构建风格。
符合或兼容于这种架构风格的网络服务,允许客户端发出以统一资源标识符访问和操作网络资源的请求,而与预先定义好的无状态操作集一致化。
接口文档
在项目开发中,web项目的前后端分离开发源码,APP开发,需要由前后端工程师共同定义接口,编写接口文档,之后大家都根据这个接口文档进行开发,到项目结束前都要一直维护。
为啥要提前提供接口规范文档
因为项目初期,需求确定后就要进行开发。而在开发过程中,都是团队协作。每个人不是孤军奋战,尤其在前后端分离的项目电销外呼程序上接口规范文档尤其重要。
这里简单说下一个概念:前后端分离,就是前台负责做页面,调用后台的接口服务获取数据,然后渲染页面,呈现给用户。后端需要提供接口能力,保证功能稳定性。
在实际过程,前端开发设计需要时间,而后端开发接口也同样需要时间,所以先提供接口规范有利于前端根据接口规范,模拟返回数据源码,进行模拟测试。而后台在这段时间也可以开发接口服务,等到按照预期的联调时间,就可以前后台进行正式联调。
为啥需要正式联调,因为接口规范可能会在实际开发过程中发生变动,前端第一次根据后台的接口规范构造的模拟数据,不足以证明后期的实际联调没问题。
在正式联调后,确定最终的接口规范文档,对外发布。
合格的接口规范文档
明确定义接口的名字、作用。这样有利于读者对接口所涉及的业务功能有清晰的概念。定义接口的URL地址。定义接口的请求方式,如GET请求、POST请求。定义接口请求的Header头部信息,比如定义"Content-Type": "application/json;charset=UTF-8"。定义接口的参数字段名、字段类型、是否必填、说明字段的意义、备注(可选)。定义接口返回的状态码,比如常见的200 OK。定义接口返回的的Header头部信息。定义接口返回的响应结果。(可选)提供接口返回的请求例子、响应结果例子。
团队合作,文档先行,编码在后,这样有利于整体项目如期完成。
希望该回答,可以帮助到你。