RESTful API 设计风格

HTTP常用动词

  • GET(SELECT):从服务器取出资源(一项或多项)。
  • POST(CREATE):在服务器新建一个资源。
  • PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。
  • PATCH(UPDATE):在服务器更新资源(客户端提供改变的属性)。
  • DELETE(DELETE):从服务器删除资源

RESTful架构设计规范:

URL中最好不要出现动词,尽量使用名词复数

URL中可以带版本号,也可以在请求头中携带版本号,但不如放入URL中直观

过滤参数可以放在查询字符串中

针对不同操作,服务器返回不同的响应数据

响应数据格式尽量使用JSON

响应状态码:1**(被接收,需要继续处理),2**(请求成功),3**(请求重定向),4**(请求错误),5**(服务器错误)

应该尽量将API部署在专用域名下,如果API很简单,且不会有进一步扩展,可以考虑放在主域名下

RESTful API最好做到Hypermedia(即返回结果中提供链接,指向其他API方法),使得用户不查文档,也知道下一步应该做什么。

RESTful API 设计风格

上一篇:CSS基础知识之文本属性二三事


下一篇:c# 关于抓取网页源码后中文显示乱码的原因分析和解决方法