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方法),使得用户不查文档,也知道下一步应该作什么。扩展

相关文章
相关标签/搜索