认识RESTfull

在前后端分离的应用模式里，后端API接口如何定义？
      需要一种规范和风格来约束后端程序员对接口的定义,RESTfull就是用来约束后端程序员对接口的定义的一种风格

描述
      RESTfull，即 Representational State Transfer的缩写。维基百科称其为“具象状态传输”，国内⼤部分⼈理解为“表现层状态转化”。
      RESTfull是一种开发理念，维基百科说：REST是设计风格而不是标准,RESTfull架构就是：每一个URL代表一种资源；客户端和服务器之间，传递这种资源的某种表现层；客户端用户四个HTTP动词，对服务器资源进行操作，实现“表现层状态转化”。

RESTfull设计方法

  • 域名：应该尽量将API部署在专用域名之下。
  • 路径：路径又称“终点”，表示API的具体网址，每个网址代表一种资源
    1）资源作为网址，只能有名词，不能有动词，而且所用的名词往往与数据库的表名对应
    2）API的名词应该使用复数，无论子资源或者所有资源
  • 版本：应该将API的版本号放入URL。
  • 过滤信息：如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。
  • ?limit=10：指定返回记录的数量
  • ?offset=10：指定返回记录的开始位置。
  • ?page=2&per_page=100：指定第几页，以及每页的记录数。
  • ?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
  • ?animal_type_id=1：指定筛选条件
  • 状态码：
  • HTTP动词：对资源的具体操作类型，常用的有四种：
    • GET：从服务器取出资源（一项或多项）
    • POST：在服务器新建一个资源
    • PUT：在服务器更新资源（客户端提供改变的属性）
    • DELETE：从服务器删除资源
  • 错误处理：如果状态码是4xx，服务器就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。
  • 返回结果： 针对不同操作，服务器向用户返回的结果应该符合以下规范。
    • GET /collection：返回资源对象的列表（数组）
    • GET　／collection：返回单个资源对象
    • POST：返回新生成的资源对象
    • PUT：返回更新后的资源对象
    • DELETE：返回一个空文档
  • 超媒体：RESTful API最好做到Hypermedia（即返回结果中提供链接，连向其他API方法），使得用户不查文档，也知道下一步应该做什么。
  • 数据传输格式：服务器返回的数据格式，应该尽量使用JSON，避免使用XML