请求
- Content-Type: application/json
- 写入 JSON 时发送 Content-Type: application/json。
- data · meta
- 成功响应包含 data 和 meta；集合响应还说明分页信息。
- error.code · error.message
- 错误包含 error.code、error.message，并在适用时提供字段信息。
数据类型
- 必填与允许 null 是独立概念。
- 如果架构允许，必填字段可以合法地包含 null。
- 请保留 JSON 布尔值、整数、字符串和 null 的类型，不要强制转换。
- 金额以十进制字符串表示；不要使用二进制浮点数计算价格。
64-bit · expected_version
- 部分并发控制版本使用有符号 64 位整数。
- 对于超出 Number.MAX_SAFE_INTEGER 的值，JavaScript 客户端必须采用无损 JSON 处理，并发送原始整数表示。
- 不要对版本取近似值，也不要将其转换为 JSON 字符串。
请求头与响应头
Cache-Control字符串可选响应缓存策略。
const:"no-store"X-Correlation-ID字符串可选用于跟踪本次 HTTP 请求的标识符。
WWW-Authenticate字符串可选服务器要求的身份验证方案。
Allow字符串可选此资源支持的 HTTP 方法。
Retry-After整数可选重试前最少等待的秒数。
minimum:0Location字符串可选已创建资源的相对 URL。