谈统一接口协议设计

作为一名Java后端开发人员,每个需求都涉及到接口开发。在多人开发项目中,每个人对于接口的设计都是不同的,我可以返回我认为这样非常友好的数据格式,你也可以返回你认为非常友好的数据格式,这样可以么?从功能实现的角度出发,这样是完全没有问题的。但是,如果大家开发代码的时候都按照自己的认为的逻辑去开发代码,没有统一的规范,项目交付之后负责项目维护的小伙伴就惨了,他要了解前开发人员的所有接口协议...另一方面,不同的接口协议对于前端来说也是一个灾难,例如有许多前端框架可以做到对Ajax的请求做到统一封装,错误异常统一处理。如果没有统一接口协议,这些前端比较优秀的处理方案就无法实施。

为什么要统一接口协议设计?

1 利于前后端交互。

2 方便维护。

如何设计?

正常的接口一般是下面的样子:

接口设计需要遵循的规则?

API Restful 

关于API是否一定要遵循Restful风格,这篇博文讲述的非常详细,参考文章链接直达

参考文章

posted @ 2022-08-19 15:44  梨小落是个小疯子  阅读(174)  评论(0)    收藏  举报