Java如何设计API接口实现统一格式返回.docx
《Java如何设计API接口实现统一格式返回.docx》由会员分享,可在线阅读,更多相关《Java如何设计API接口实现统一格式返回.docx(3页珍藏版)》请在冰豆网上搜索。
![Java如何设计API接口实现统一格式返回.docx](https://file1.bdocx.com/fileroot1/2023-1/8/1feb15ec-6eb0-446f-83df-ea8273f35fa6/1feb15ec-6eb0-446f-83df-ea8273f35fa61.gif)
Java如何设计API接口实现统一格式返回
Java如何设计API接口,实现统一格式返回
前言
在移动互联网,分布式、微服务盛行的今天,现在项目绝大部分都采用的微服务框架,前后端分离方式,
(题外话:
前后端的工作职责越来越明确,现在的前端都称之为大前端,技术栈以及生态圈都已经非常成熟;以前后端人员瞧不起前端人员,那现在后端人员要重新认识一下前端,前端已经很成体系了)
一般系统的大致整体架构图如下:
需要说明的是,有些小伙伴会回复说,这个架构太简单了吧,太low了,什么网关啊,缓存啊,消息中间件啊,都没有。
因为老顾这篇主要介绍的是API接口,所以我们聚焦点,其他的模块小伙伴们自行去补充。
接口-交互
前端和后端进行交互,前端按照约定请求URL路径,并传入相关参数,后端服务器接收请求,进行业务处理,返回数据给前端。
针对URL路径的restful风格,以及传入参数的公共请求头的要求(如:
app_version,api_version,device等),老顾这里就不介绍了,小伙伴们可以自行去了解,也比较简单。
后端服务器如何实现把数据返回给前端?
返回格式
后端返回给前端我们一般用JSON体方式,定义如下:
CODE状态码
code返回状态码,一般小伙伴们是在开发的时候需要什么,就添加什么。
如接口要返回用户权限异常,我们加一个状态码为101吧,下一次又要加一个数据参数异常,就加一个102的状态码。
这样虽然能够照常满足业务,但状态码太凌乱了
我们应该可以参考HTTP请求返回的状态码
我们可以参考这样的设计,这样的好处就把错误类型归类到某个区间内,如果区间不够,可以设计成4位数。
这样前端开发人员在得到返回值后,根据状态码就可以知道,大概什么错误,再根据message相关的信息描述,可以快速定位。
Message
这个字段相对理解比较简单,就是发生错误时,如何友好的进行提示。
一般的设计是和code状态码一起设计,如: