1. 请求规范

1. 接口版本规范

请求接口的时候可以不用传递版本号，默认使用最新的接口版本，如果需要手动设置版本号，则版本号的参数名成统一为 version，则传递版本号的位置有如下：

通过 URL 参数设置版本号，如：https://www.xxx.com?version=1.0

通过 header 中设置版本号

通过 header 中的参数 content-type 中设置版本号，如 application/json; charset=utf-8; version=1.0
通过以上方式中的一种设置即可

💡

注意：如果全都设置，则优先级为： Url>header>content-type

2. 请求追踪

如果要自定义追踪ID，则可以手动在 header 中设置 Request-Trace-Id 参数，该参数的值必须是一个 GUID 类型的字符串，如果不设置，系统会自动生成，并且在应答的时候通过响应的消息传递

3. 请求数据规范

所有 POST 请求的数据均采用 JSON 格式，请求在请求的时候设置 content-type 为 application/json，并且字符编码为 utf-8,如：application/json; charset=utf-8

2. 响应规范

应答消息都采用 JSON 格式，并且我们规定了统一的消息规范，如下：

其中 errorCode，description，version，traceId 为固定格式 content 为响应的内容。content有可能是一个 object，也可能是 null，也可能是一个 string，也可能是一个 number，不同的业务应答的消息内容不同。

参数	数据类型	是否可空	说明
errorCode	int	否	错误代码
`description`	string	是	错误描述字符串
`version`	string	否	当前请求的接口版本字符串
`traceId`	string	否	追踪ID 字符串
`content`	object	是	应答的消息内容，可能是一个对象，也可能是null，也可能是一个字符串，具体详见实际的业务约定

请求及响应规范

1. 请求规范#

2. 响应规范#

1. 请求规范

2. 响应规范