1. URI

URI规范

1. 不用大写；


2. 用中杠-不用下杠_；


3. 参数列表要encode；


4. URI中的名词表示资源集合，使用复数形式。

资源集合 vs 单个资源

/zoos //所有动物园
/zoos/1/animals //id为1的动物园中的所有动物

/zoos/1 //id为1的动物园
/zoos/1;2;3 //id为1，2，3的动物园

避免层级过深的URI

对Composite资源的访问

组合实体不是first-class的实体，它的生命周期完全依赖父实体，无法独立存在，在实现上通常是对数据库表中某些列的抽象，不直接对应表，也无id。一个常见的例子是 User — Address，Address是对User表中zipCode/country/city三个字段的简单抽象，无法独立于User存在。必须通过User索引到Address：GET /user/1/addresses

2. Request

HTTP方法

GET /zoos
GET /zoos/1
GET /zoos/1/employees

POST /animals  //新增动物
POST /zoos/1/employees //为id为1的动物园雇佣员工

PUT /animals/1
PUT /zoos/1

DELETE /zoos/1/employees/2
DELETE /zoos/1/employees/2;4;5
DELETE /zoos/1/animals  //删除id为1的动物园内的所有动物

安全性和幂等性

1. 安全性：不会改变资源状态，可以理解为只读的；


2. 幂等性：执行1次和执行N次，对资源状态改变的效果是等价的。

复杂查询

Bookmarker

GET /trades?status=closed&sort=created,desc

GET /trades#recently-closed
或者
GET /trades/recently-closed

Format

1. Content-Type: application/json
   

   POST /v1/animal HTTP/1.1
   Host: api.example.org
   Accept: application/json
   Content-Type: application/json
   Content-Length: 24
   
   {   
     "name": "Gir",
     "animalType": "12"
   }

   
   


2. Content-Type: application/x-www-form-urlencoded (浏览器POST表单用的格式)
   

   POST /login HTTP/1.1
   Host: example.com
   Content-Length: 31
   Accept: text/html
   Content-Type: application/x-www-form-urlencoded
   
   username=root&password=Zion0101

   
   


3. Content-Type: multipart/form-data; boundary=—-RANDOM_jDMUxq4Ot5 (表单有文件上传时的格式)

Content Negotiation

1. http header Accept：
   

   Accept:application/xml;q=0.6,application/atom+xml;q=1.0

   
   q为各项格式的偏好程度


2. url中加文件后缀：/zoo/1.json

6. Response

1. 不要包装：
   response 的 body 直接就是数据，不要做多余的包装。错误示例：
   

   {
       "success":true,
       "data":{"id":1,"name":"xiaotuan"},
   }

   
   


2. 各HTTP方法成功处理后的数据格式：
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   

   ·	response 格式
   GET	单个对象、集合
   POST	新增成功的对象
   PUT/PATCH	更新成功的对象
   DELETE	空

   
   


3. json格式的约定：
   
   
   
   1. 时间用长整形(毫秒数)，客户端自己按需解析（moment.js）
   
   
   2. 不传null字段
   
   
   
   

分页response

{
    "paging":{"limit":10,"offset":0,"total":729},
    "data":[{},{},{}...]
}

7. 错误处理

1. 不要发生了错误但给2xx响应，客户端可能会缓存成功的http请求；


2. 正确设置http状态码，不要自定义；


3. Response body 提供 1) 错误的代码（日志/问题追查）；2) 错误的描述文本（展示给用户）。

1. 如果抛出该类异常，HTTP 响应状态码应该设成什么；


2. 异常的文本描述；

1. 设置 HTTP 响应状态码：对业务类异常，用它指定的 HTTP code；对非业务类异常，统一500；


2. Response Body 的错误码：异常类名


3. Response Body 的错误描述：对业务类异常，用它指定的错误文本；对非业务类异常，线上可以统一文案如“服务器端错误，请稍后再试”，开发或测试环境中用异常的 stacktrace，服务器端提供该行为的开关。

8. 服务型资源

1. 按关键字搜索；


2. 计算地球上两点间的距离；


3. 批量向用户推送消息

GET /search?q=filter?category=file  搜索
GET /distance-calc?lats=47.480&lngs=-122.389&late=37.108&lnge=-122.448
POST /batch-publish-msg
[{"from":0,"to":1,"text":"abc"},{},{}...]

9. 异步任务

提交任务：
POST /batch-publish-msg
[{"from":0,"to":1,"text":"abc"},{},{}...]

返回：
{"taskId":3,"createBy":"Anonymous","status":"running"}

GET /task/3
{"taskId":3,"createBy":"Anonymous","status":"success"}

提交任务：
POST /batch-publish-msg
[{"from":0,"to":1,"text":"abc"},{},{}...]

返回：
{"taskId":3,"createBy":"Anonymous"}

GET /task/3/status
{"progress":"50%","total":18,"success":8,"fail":1}

10. API的演进

版本

1. 在uri中放版本信息：GET /v1/users/1


2. Accept Header：Accept: application/json+v1


3. 自定义 Header：X-Api-Version: 1

URI失效

11. 安全

参考文档

1. < RESTful Web Services Cookbook >


2. Consumer-Centric API Design


3. RESTful Best Practices