06.API 返回值是遵循 RESTful 规范吗？

:::info API 返回值是遵循 RESTful 规范的。 :::

返回值规范

• 使用标准的 HTTP 响应状态码，参考规范；
• 发生错误时，需设置 Response Body 的错误码；
• 发生错误时，需设置 Response Body 的错误文本；

错误返回

HTTP 响应状态码，不要设置成 200 ！需遵循 RFC 标准。

// 错误时 Response Body 结构
type Failure struct {
    Code    int    `json:"code"`    // 业务码
    Message string `json:"message"` // 描述信息
}

正确返回

HTTP 响应状态码，设置成 200，Response Body 结构为返回的数据结构。

示例

参考大厂

• Google 遵守规范；
• Github 遵守规范；
• Microsoft 遵守规范 [推荐] ；
• Twitter 遵守规范；
• 阿里云 遵守规范；