我的 Restful 接口规范

1. Restful 接口主要元素

1. resource
2. endpoint：endpoint 中的 resource 使用「复数」形式，例如：/users/1
3. http method：POST（增），DELETE（删），PUT（改），查（GET）

2. 返回规范

2.1 返回数据格式 JSON

{
    "code": 0,
    "message": "ok",
    "data": {}
}

2.2 POST 和 PUT 响应内容

返回（创建/更新）资源的详情 JSON，包括 id

2.3 DELETE 响应内容

返回删除的记录 id 以及删除的资源数量

{
    "code": 0,
    "message": "[Resource] deleted for id 1234567",
    "data": {
        "deleteCount": 1
    }
}

当要删除一个已经删除的内容，则提示已经删除

{
    "code": 0,
    "message": "[Resource] already deleted for id 1234567",
    "data": {
        "deleteCount": 0
    }
}

3. 参考资料

Restful API 通用设计规则