0%

eosvoter | 接口文档

这个项目一开始并不是我一个人负责。前端的架构是外包的。

并且,由于前后端分离,所以,接口规范非常重要。

在这里,我总结一下,在和外包合作时候的注意点。

关于 rest 的接口规范,希望你可以看我下面的博文。

编程规范 | rest 接口篇


即时的沟通


前端用的是 vue ,所以,在后端没有数据产生的时候,前端是通过自己伪造数据来展示的。

最开始的时候,我还没来,那个时候是瑞哥和他对接的,到后来,我和瑞哥讨论的时候,修改了一个数据结构,但是,忘了和对方说,导致出来的页面错误。


接口有效的分类


项目进行到后期,接口越来越多,所以,接口分类也很重要,但是,我的文档接口其实并没有分类,但是,我在 postman 中分了类。


接口的书写规范



利用颜色标注接口是否完成


一般接口在开发过程中,有正在开发、正在协商、未来接口和稳定版本。

所以,我将不同接口的标题按照颜色分别进行标注,这样,前后端分离的时候,前端就可以优先做稳定版本的。

请我喝杯咖啡吧~