加入收藏 | 设为首页 | 会员中心 | 我要投稿 湖南网 (https://www.hunanwang.cn/)- 科技、建站、经验、云计算、5G、大数据,站长网!
当前位置: 首页 > 建站 > 正文

怎样计划API接口,实现同一名目返回?

发布时间:2019-10-01 09:56:32 所属栏目:建站 来源:程序猿久一
导读:媒介 在移动互联网,漫衍式、微处事流行的本日,此刻项目绝大部门都回收的微处事框架,前后端疏散方法,(题外话:前后端的事变职责越来越明晰,此刻的前端都称之为大前端,技能栈以及生态圈都已经很是成熟;早年后端职员瞧不起前端职员,那此刻后端职员要
副问题[/!--empirenews.page--]

媒介

在移动互联网,漫衍式、微处事流行的本日,此刻项目绝大部门都回收的微处事框架,前后端疏散方法,(题外话:前后端的事变职责越来越明晰,此刻的前端都称之为大前端,技能栈以及生态圈都已经很是成熟;早年后端职员瞧不起前端职员,那此刻后端职员要从头熟悉一下前端,前端已经很成系统了)。

一样平常体系的大抵整体架构图如下:

怎样计划 API 接口,实现同一名目返回?

必要声名的是,有些小搭档会回覆说,这个架构太简朴了吧,太low了,什么网关啊,缓存啊,动静中间件啊,都没有。由于老顾这篇首要先容的是API接口,以是我们聚核心,其他的模块小搭档们自行去增补。

接口交互

前端和后端举办交互,前端凭证约定哀求URL路径,并传入相干参数,后端处事器吸取哀求,举办营业处理赏罚,返回数据给前端。

针对URL路径的restful气魄沤背同以及传入参数的民众哀求头的要求(如:app_version,api_version,device等),老顾这里就不先容了,小搭档们可以自行去相识,也较量简朴。

后端处事器怎样实现把数据返回给前端?

返回名目

后端返回给前端我们一样平常用JSON体方法,界说如下:

{ #返回状态码 code:integer,  #返复书息描写 message:string, #返回值 data:object}

CODE状态码

code返回状态码,一样平常小搭档们是在开拓的时辰必要什么,就添加什么。

如接口要返回用户权限非常,我们加一个状态码为101吧,下一次又要加一个数据参数非常,就加一个102的状态码。这样固然可以或许照常满意营业,但状态码太缭乱了

我们应该可以参考HTTP哀求返回的状态码

:下面是常见的HTTP状态码:

200 - 哀求乐成

301 - 资源(网页等)被永世转移到其余URL

404 - 哀求的资源(网页等)不存在

500 - 内部处事器错误

怎样计划 API 接口,实现同一名目返回?

我们可以参考这样的计划,这样的甜头就把错误范例归类到某个区间内,假如区间不足,可以计划成4位数。

#1000~1999 区间暗示参数错误

#2000~2999 区间暗示用户错误

#3000~3999 区间暗示接口非常

这样前端开拓职员在获得返回值后,按照状态码就可以知道,或许什么错误,再按照message相干的信息描写,可以快速定位。存眷微信公家号 Java后端 获取更多推送。

Message

这个字段相对领略较量简朴,就是产生错误时,怎样友爱的举办提醒。一样平常的计划是和code状态码一路计划,如

怎样计划 API 接口,实现同一名目返回?

再在列举中界说,状态码

怎样计划 API 接口,实现同一名目返回?

状态码和信息就会逐一对应,较量好维护。

Data

返回数据体,JSON名目,按照差异的营业又差异的JSON体。

我们要计一律个返回体类Result

怎样计划 API 接口,实现同一名目返回?

节制层Controller

我们会在controller层处理赏罚营业哀求,并返回给前端,以order订单为例

怎样计划 API 接口,实现同一名目返回?

我们看到在得到order工具之后,我们是用的Result结构要领举办包装赋值,然后举办返回。小搭档们有没有发明,结构要领这样的包装是不是很贫困,我们可以优化一下。存眷微信公家号 Java后端 获取更多推送。

雅观美化

我们可以在Result类中,插手静态要领,一看就懂

怎样计划 API 接口,实现同一名目返回?

(编辑:湖南网)

【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容!

热点阅读