• 时间:
  • 分类: API

Representational state transfer （REST）或者 RESTful
特点：结构清晰、符合标准、易于理解、扩展方便
REST这个词，是Roy Thomas Fielding在他2000年的博士论文中提出的。

什么是RESTful架构：

  1. 每一个URI代表一种资源；
  2. 客户端和服务器之间，传递这种资源的某种表现层；
  3. 客户端通过四个HTTP动词，对服务器端资源进行操作，实现"表现层状态转化"。

总结：

  • URL定位资源，用HTTP动词（GET,PUT,POST,DELETE,HEAD,OPTIONS）描述操作。
  • REST描述的是在网络中client和server的一种交互形式；
  • REST本身不实用，实用的是如何设计 RESTful API（REST风格的网络接口）
  • Server提供的RESTful API中，URL中只使用名词来指定资源，原则上不使用动词。
  • “资源”是REST架构或者说整个网络处理的核心

HTTP动词

  • GET（SELECT）：从服务器取出资源（一项或多项）。
  • POST（CREATE）：在服务器新建一个资源。
  • PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
  • PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。
  • DELETE（DELETE）：从服务器删除资源。
  • HEAD：获取资源的元数据。
  • OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。

URL 设计举例：

/docs/api/{children}?parent_id=:parent_id

methodurlfile pathcontroller name
GET/doc/api/{parents}/:parent_id/{children}/:child_id/{objects}?per_page={per_page}&page={page}app/apis/{parents}/{objects}.jsindex()
GET/doc/api/{parents}/:parent_id/{children}/:child_id/{objects}/:idapp/apis/{parents}/{objects}.jsshow()
POST/doc/api/{parents}/:parent_id/{children}/:child_id/{objects}app/apis/{parents}/{objects}.jscreate()
PUT/doc/api/{parents}/:parent_id/{children}/:child_id/{objects}/:idapp/apis/{parents}/{objects}.jsupdate()
DELETE/doc/api/{parents}/:parent_id/{children}/:child_id/{objects}/:id[s]app/apis/{parents}/{objects}.jsdestroy()

过滤条件

  • ?limit=10：指定返回记录的数量
  • ?skip=10：指定返回记录的开始位置。
  • ?page=2&per_page=100：指定第几页，以及每页的记录数。
  • ?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
  • ?animal_type_id=1：指定筛选条件
  • ?fields=field1,field2,field3…… ：指定返回的字段名

常用状态码

  • 200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
  • 201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
  • 202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
  • 204 NO CONTENT - [DELETE]：用户删除数据成功。
  • 400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
  • 401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
  • 403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
  • 404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
  • 406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
  • 410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
  • 422 Unprocessable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
  • 500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

http status http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
RESTful架构 http://www.ruanyifeng.com/blog/2011/09/restful.html
RESTful api 设计指南 http://www.ruanyifeng.com/blog/2014/05/restful_api.html
百科地址 https://en.wikipedia.org/wiki/Representational_state_transfer

标签: Restfull, Rest

评论已关闭