如/v1/users POST表示注册新的用户,那么针对这一个POST API,返回值有以下几种情况:1. 正确响应,返回200, body体为用户id;2. 请求body体不符合要求,返回400。body体:错误码001,错误信息:请求body体无效3. 服务内部错误,返回500。body体:错误码1000,错误信息:内部错误如上,如何在API中表征。
可以在返回示例给出成功、失败示例。
目前每个 API 仅支持填写一种成功、失败示例,其余情况可在项目文档 或 API 额外说明内表征。
错误码可在错误码字段的值可能性内标示。
若所有错误码是统一且全局唯一的,可以统一维护到状态码文档中。