RESTful 设计

URI 设计

GET    /users/1
PUT    /users/2
POST   /users
DELETE /users/1

// 将某个用户加入到某个 Team 中
PUT /users/1?team_id=1
PUT /users/${user_id}?team_id=${team_id}
PUT /users/:user_id/team_id/:team_id

// 将某个 Team 中的某个用户设置为非激活状态
PUT /term/1?user_id=1&status=inactive
PUT /term/:term_id/user_id/:user_id/inactive

// 订阅栏目，表示订阅用户666的ID为1的项目，
POST /v1/users/1/projects/1/subscribe

// 收藏栏目，则将“收藏项目”这个动作抽象为“给项目加一颗星”。
POST /v1/users/1/projects/1/star


GET /zoos：列出所有动物园
POST /zoos：新建一个动物园
GET /zoos/ID：获取某个指定动物园的信息
PUT /zoos/ID：更新某个指定动物园的信息（提供该动物园的全部信息）
PATCH /zoos/ID：更新某个指定动物园的信息（提供该动物园的部分信息）
DELETE /zoos/ID：删除某个动物园
GET /zoos/ID/animals：列出某个指定动物园的所有动物
DELETE /zoos/ID/animals/ID：删除某个指定动物园的指定动物

// 复杂查询 过滤信息(排序、分页、筛选、搜索等)
?limit=10：指定返回记录的数量
?offset=10：指定返回记录的开始位置。
?page=2&per_page=100：指定第几页，以及每页的记录数。
?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
?animal_type_id=1：指定筛选条件

冗余设计

主要是目录层级、查询、标识之间的冗余
比如
/device/id/image/imgId
/image/imgId?deveci=id

参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。比如以下两个请求含义相同

GET /zoo/:id/animals
GET /animals?zoo_id=:id

Header 头设计

• 重写方法 - X-HTTP-Method-Override
• 版本 - Accept: vnd.example-com.foo+json; version=1.0
• 响应类型 - Accept: application/json Content-Type: application/json
• 缓存 -
  • Expires: Mon, 11 Jun 2018 13:55:41 GMT
  • Cache-Control: public, max-age=60
• 编码 -

状态码设计

• 1xx：相关信息
• 2xx：操作成功
• 3xx：重定向
• 4xx：客户端错误
• 5xx：服务器错误

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

方法

方法名	介绍
GET	请求指定的页面信息，并返回实体主体。
HEAD	类似于 GET 请求，只不过返回的响应中没有具体的内容，用于获取报头
POST	向指定资源提交数据进行处理请求（例如提交表单或者上传文件）。数据被包含在请求体中。POST 请求可能会导致新的资源的建立和/或已有资源的修改。
PUT	从客户端向服务器传送的数据取代指定的文档的内容。
DELETE	请求服务器删除指定的页面。
CONNECT	HTTP/1.1 协议中预留给能够将连接改为管道方式的代理服务器。
OPTIONS	允许客户端查看服务器的性能。
TRACE	回显服务器收到的请求，主要用于测试或诊断。
PATCH	是对 PUT 方法的补充，用来对已知资源进行局部更新 。

• GET：读取（Read）
• POST：新建（Create）
• PUT：更新（Update）
• PATCH：更新（Update），通常是部分更新
• DELETE：删除（Delete）

安全

• 幂等，重复提交

附录

防重复提交

• 前端控制
• 后台控制，使用锁
• 后台生成一个key供前端使用，后端再控制

参考

RESTful API URI 设计: 查询（Query）和标识（Identify）
理解并设计rest/restful风格接口
Restful api 防止重复提交