RESTFUL api设计规范

一：URI

• 应该将api部署在专用域名之下。
• URL中尽量不要大写
• URL中尽量不要出现动词
• URI中的名词表示资源集合，使用复数形式
• URI中可以包含queryString，避免层级过深
  • 举例 url？a=1 & b = 2 & c = 3 这里的a b c 就是queryString

二：HTTP动词

对于资源的具体操作类型，由HTTP动词表示，常用的动词有以下五个；

• GET：从服务器取出资源（一项或者多项）
• POST：在服务器新建一个资源
• PUT：在服务器更新资源（客户端提供改变后的完整资源）
• PATCH：在服务器更新资源（客户端提供改变的属性）
• DELETE：从服务器删除资源

三：状态吗（Status Codes）

处理请求后，服务端需要向客户端返回状态码和提示信息

• 200:success请求成功
• 401:Unauthorized无权限
• 403:Forbidden 禁止访问
• 410:Gone 无此资源
• 500:服务器发生错误

四：错误处理

如果服务器发生错误或者资源不可达，应该向用户返回出错信息
建议使用全局异常处理，发生异常即会被拦截并统一处理，返回错误的result对象给前端

五：服务端数据返回

后端的返回结果最好使用json格式，且格式统一