美文网首页
返回报文格式规范

返回报文格式规范

作者: JerryDai | 来源:发表于2020-04-28 23:04 被阅读0次

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

请求时间

相关文章

  • 返回报文格式规范

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

  • Spring Security OAuth 个性化token

    个性化Token 目的 默认通过调用 /oauth/token 返回的报文格式包含以下参数 并没包含用户的业务信息...

  • 1.4 HTTP标准

    1.4.1. 报文格式 1.4.1.1. 请求报文格式 1.4.1.2. 响应报文格式 1.4.1.3. 字段解释...

  • [Swift]函数

    Swift3.0以后删除了 ++ -- 函数的定义 返回元组:实现多元返回 函数文档规范 官方规范 参数标签 (A...

  • Ping程序

    ping程序通过发送一份ICMP回显请求报文给目标主机,然后等待返回ICMP回显应答 报文格式: unix系统在实...

  • ??这是标题

    你好啊啊返回符合规范分工fdvdf

  • FastCGI

    一、FastCGI 协议 1、FastCGI报文格式 FastCGI报文格式如下: FastCGI报文是8字节对齐...

  • 2018-06-11

    Controller 规范 1.统一返回值, 返回AbstractBean或PageBean 正确范例: 错误范例...

  • HTTP:详解三次握手和四次挥手

    一、TCP报文格式 TCP报文格式图: 序号, Seq(Sequence number), 占32位,用来标识从T...

  • 423423

    规范化你发个还是屌返回大公会

网友评论

      本文标题:返回报文格式规范

      本文链接:https://www.haomeiwen.com/subject/ljniwhtx.html