RESTful API规范

1.url链接一般都采用https协议进行传输

　　http：数据明文传输

　　https：数据加密传输 http + ssl

2.用api关键字标识接口url：

　　https://api.baidu.com

　　https://www.baidu.com/api/

3.在url链接中标识接口版本

　　https://www.baidu.com/api/v1

　　https://www.baidu.com/api/v2

4.数据即是资源，均使用名词（可复数）

　　https://www.baidu.com/api/v1/books

5.资源操作由请求方式定义

　　https://www.baidu.com/api/v1/books get请求：获取所有书

　　https://www.baidu.com/api/v1/books/1 get请求：获取id 为1的一本书

　　https://www.baidu.com/api/v1/books post请求：新增一本书

　　https://www.baidu.com/api/v1/books/1 put请求：修改id为1的书

　　https://www.baidu.com/api/v1/books/1 delete请求： 删除id为1的书

6.过滤，通过在url上传参的形式传递搜索条件

　　https://www.baidu.com/api/v1/books?limit=10 : 指定返回记录的数量

　　https://www.baidu.com/api/v1/books?offset=10：指定返回记录的开始位置

　　https://www.baidu.com/api/v1/books?page=2&per_page=100：指定第几页，以及每页的记录数

　　https://www.baidu.com/api/v1/books?sortby=name&order=asc：指定返回结构按照哪个属性排序，以及排序顺序

　　https://www.baidu.com/api/v1/books?type_id=1：指定筛选条件

7.响应状态码

　　200：常规请求（成功）

　　201：创建成功

　　301：永久重定向

　　302：临时重定向

　　403：请求无权限

　　404：请求路径不存在

　　405：请求方法不存在

　　500：服务器异常

　　业务状态码：可自定义，100001，100002...

8.错误处理，应返回错误信息，error当做key

　　{ error: "无权限操作！"}

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

　　GET /books：返回资源对象的列表

　　GET /books/1：返回单个资源对象

　　POST /books：返回新生成的资源对象

　　PUT /books：返回完整的资源对象

　　DELETE /books/1：返回一个空文档

10.需要url请求的资源需要访问资源的请求链接