restful 规范

Posted 2021-01-25 stupid-dog

restful 规范

• 根据method不同，进行不同操作
  • GET/POST/PUT/DELETE/PATCH
• 面向资源编程
  • https://www.xxx.com/books
• 体现版本
  • https://www.xxx.com/v1/books
• 体现是api
  • https://www.xxx.com/api/v1/books
• 建议https
• 响应时状态码
  • 200/300/400/500
    • 200请求成功
    • 300重定向：301:/302
    • 400:403禁止访问，404资源不存在
    • 500：服务器问题
• 条件
  • https://www.xxx.com/api/v1/books？page=1&size=30
• 返回值
  • https://www.xxx.com/api/v1/books
    • GET:所有的数据
    • POST:返回新增数据
  • https://www.xxx.com/api/v1/books/1/
    • GET:获取单条
      • 返回单条
    • PUT：修改单条
      • 返回更新数据
    • PATCH:局部更新
      • 返回更新数据
    • DELETE：删除单条
      • 返回空
• 返回错误信息
  • {code:‘1000‘,error:‘xxx错误‘}
• 超链接API