Restful Api-接口设计

简介

Resource Representational State Transfer(不知是啥)

Restful Api

特征

(1) 每一个uri代表一种资源；

(2) 客户端和服务器之间，传递这种资源的某种表现层；

(3) 客户端通过四个HTTP动词(GET、POST、DELETE、PUT)，对服务器端资源进行操作，实现"表现层状态转化"(增删改查)。

(4) URL中通常不出现动词，只有名词

(5) 使用JSON不使用XML设计方式

使用方式

GET http://www.birjemin.com/api/user # 获取列表

POST http://www.birjemin.com/api/user # 创建用户

PUT http://www.birjemin.com/api/user/ # 修改用户信息

DELETE http://www.birjemin.com/api/user/ # 删除用户信息

过滤信息

用于补充规范一些通用字段

?limit=10 # 指定返回记录的数量

?offset=10 # 指定返回记录的开始位置

?page=2&per_page=100 # 指定第几页，以及每页的记录数

?sortby=name&order=asc # 指定返回结果按照哪个属性排序，以及排序顺序

?state=close # 指定筛选条件

状态码

字段名称为：code

错误信息

字段名称：message

示例

{"code": 200,"message": "啊哈哈","succ": true,"data": [] }

备注

为了简便，有时候code没有，或者为0，message换成msg,这些实际上实在实际项目中的，不过还是要有一个规范出来，这样方便统一管理。

参考

1.https://www.cnblogs.com/imyalost/p/7923230.html

2.http://www.ruanyifeng.com/blog/2014/05/restful_api