RESTful API开发规范阅读有感

RESTful API开发规范阅读

author:RFQ 2021/08/11 01:16

RESTful规范 - 人生不如戏 - 博客园 (cnblogs.com)

 

• api放置在单独域名下

• api的版本应当放进URL中体现

• 尽量使用HTTPs协议开发接口

• URI表示资源, 尽量不用动词、不用大写、 用'-' 不用'_' 、

• URI标识避免过深 , 如果过深考虑使用get加查询参数

• res不要包装, res的body应直接为数据

• 错误时 返回JSON信息为

  {
      error : err.message
  }
  

  以提供给客户端看书面错误描述

  同时服务器日志应console.log(err) 打印所有错误信息

• 过滤信息

  信息过多时, 不建议全部直接给客户端, 采取分页等操作

  api应当提供参数, 以过滤返回结果

  ?limit=10

  ?offset=10

  ?page=2&per_page=1

• HTTP状态码

  • 200 OK
  • 201 created
  • 204 delete success
  • 400 客户端错误
  • 401 客户无权限
  • 403 禁止访问
  • 404 NOT FOUND
  • 5XX 服务器错误

• 增删改查完之后应当返回操作对象本身

• 身份认证

  基于JWT的接口权限认证