restful 规范

一.什么是restful

• REST 与技术无关，代表的是一种软件架构风格，REST 是 Representational State Transfer 的简称，中文翻译为" 表征状态转移 "；
• REST从资源的角度类审视整个网络，它将分布在网络中某个节点的资源通过URL进行标识，客户端应用通过URL来获取资源的表征，获得这些表征致使这些应用转变状态；
• 所有的数据，不论是通过网络获取的还是操作（增删改查）的数据，都是资源，将一切数据视为资源是 REST 区别与其他架构风格的最本质属性
• 对于REST这种面向资源的架构风格，有人提出一种全新的结构理念，即：面向资源架构(ROA:Resource Oriented  Architecture)

二.RESTful API 设计

• API 与用户的通信协议，总是使用 HTTPs协议。
• 域名
  • http://api.example.com    尽量将 API 部署在专用域名（会存在跨域问题）
  • http://example.org/api/              API 很简单
• 版本
  • URL，如：https://api.example.com/v1/
  • 请求头       跨域时，引发发送多次请求
• 路径，视网络上的任何东西都是资源，均使用名词表示（可复数）
  • https://api.example.com/v1/zoos
  • https://api.example.com/v1/animals
  • https://api.example.com/v1/employees
• method
  • GET        ：从服务器取出资源（一项或多项）
  • POST      ： 在服务器新建一个资源
  • PUT         ：在服务器更新资源（客户端提供改变后的完整资源）　　　　　　
  • PATCH     ：在服务器更新资源（客户端提供改变的属性）
  • DELETE  ：从服务器删除资源
• 过滤，通过在 url 上传参的形式传递搜索条件
  • https://api.example.com/v1/zoos?limit=10   ：指定返回记录的数量
  • https://api.example.com/v1/zoos?offset=10   ：指定返回记录的开始位置
  • https://api.example.com/v1/zoos?page=2&per_page=100   ：指定第几页，以及每页的记录数
  • https://api.example.com/v1/zoos?sortby=name&order=asc  ：指定返回结果按照哪个属性排序，以及排序顺序
  • https://api.example.com/v1/zoos?animal_type_id=1   ：指定筛选条件
• 状态码

# 幂等：就是一次请求和多次请求，资源的状态是一样的。比如GET和HEAD，不论你请求多少次，资源还是在那里。请注意，DELETE和PUT也是等幂的，以为对同一个资源删除一次或者多次，结果是一样的，就是资源被删除了，不存在了。为什么说PUT也是等幂的？当你PUT一个新资源的时候，资源被创建，再次PUT这个URI的时候，资源还是没变。当你PUT一个存在的资源时，更新了资源，再次PUT的时候，还是更新成这个样子。在PUT更新的时候，不能做相对的更新（依赖资源现在的状态），比如每次对一个数加1，这样资源状态就会变化。应该每次更新成某个数，比如把某个数变成4，则无论多少次PUT，值都是4，这样就是等幂了。

# 状态码

• 错误处理，状态码是4xx时，应返回错误信息，error 当作 key。

{
    error:"Invalid API key"
}

• 返回结果，针对不同操作，服务器向用户返回的结果应该符合以下规范。

GET   /collection:返回资源对象的列表（数组）
GET   /collection/resource:返回单个资源对象
POST   /collection:返回新生成的资源对象
PUT   /collection/resource:返回完整的资源对象
PATCH   /collection/resource:返回完整的资源对象
DELETE   /collection/resource:返回一个空文档

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

{"link":{
    "rel":" collection https://www.example.com/zoos",
    "href": "https://api.example.com/zoos",
    "title": "List of zoos",
    "type": "application/vnd.yourformat + json"
    }
}

具体参照 RESTful API 设计指南