返回报文格式规范

http请求响应代码决定接口是否可以调用,而具体的报文code意味着这个服务的逻辑是否正常运行。以下讨论的是报文返回的规范。

1. JSON 格式

{
    "code" : "",
    "message" : "",
    "data" : Object,
    "extra" : Object,
    "timestamp" : Time
}

2. 具体说明

2.1 code

2.1.1 描述

指错误代码,特定的错误代码就像程序中定义的 Exception 一样,具有标志性。需要告诉对方,那些是需要提示的异常,那些是不可预知的异常,都需要在此进行定义与规范。

2.1.2 定义

通常定义 code 需要区分模块。0(0000000) 代表成功其他则代表异常。而异常又是区分提示性质和全局异常。如:

   系统  提示/异常   模块      异常码
    |       |        |          | 
    AA    (0/1)  (000~999)  (000~999)
  • 系统:使用2个字母表示A-Z(676个组合)
  • 提示/异常:区分需要提示的异常,比如说参数缺失,输入异常等。有部分异常需要抛出到前端,有些需要服务自行消化的。
  • 模块:一个系统中的模块(999个组合)
  • 异常码:每个模块中的异常码(999个组合)

其中需要划分通用异常码区域(指定模块是 001 ),主要用于各个模块整合的时候定义通用的错误。比如登陆账号已经退出(可能服务与服务之间感知时间不一样,导致数据出现异常)。整合到前端的时候可以更好处理相关的跳转逻辑。如:

   系统  提示/异常   模块   异常码
    |       |        |       | 
    AA    (0/1)     001  (000~999)

2.2 message

主要提示性的消息,这里可以依据浏览器的语言做国际化处理。

2.3 data

具体使用的数据,请求成功后的话,此处是有数据的。

2.4 extra

更多用于此接口(data)已经提供到外部使用,但是在不增加新接口与修改接口的情况下需要对接口的数据格式进行扩展,可以将数据写到这里。

2.5 timestamp

请求时间

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,064评论 5 466
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,606评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,011评论 0 328
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,550评论 1 269
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,465评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 47,919评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,428评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,075评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,208评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,185评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,191评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,914评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,482评论 3 302
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,585评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,825评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,194评论 2 344
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,703评论 2 339

推荐阅读更多精彩内容