RESTful设计

  1. 协议: 必须使用https.
  2. 域名: https://api.example.com or https://example.org/api.
  3. 版本: https://api/example.com/v1.
  4. 路径:不能有动词,只有名次,而且名词往往和数据库表对应.

  5. HTTP动词: 括号里对应的SQL命令

    5.1. GET (SELECT): 从服务器取出资源(一项或多项).

    5.2. POST (CREATE): 在服务器新建一个资源.

    5.3. PUT (UPDATE): 在服务器更新资源(客户端提供改变的属性).

    5.4. PATCH (UPDATE): 在服务器更新资源(客户端提供改变的属性).

    5.5 DELETE (DELETE): 从服务器删除资源.

    5.6 HEAD: 获取资源的元数据(不常用).

    5.7 OPTIONS: 获取信息,关于资源的哪些属性是客户端可以改变的.

    例子

     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：删除某个指定动物园的指定动物

6.0 过滤信息

?limit=10：指定返回记录的数量
?offset=10：指定返回记录的开始位置。
?page=2&per_page=100：指定第几页，以及每页的记录数。
?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
?animal_type_id=1：指定筛选条件

7.0 状态吗

200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
204 NO CONTENT - [DELETE]：用户删除数据成功。
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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

更全http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

8.0 错误处理

{
error: "Invalid API key"
}

9.0 返回结果

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

10.0 Hypermedia API

RESTful的API最好做到Hypermedia API,既返回结果中提供链接,连向其他API方法,使得用户不查文档,也知道下一步该作什么.

比如，当用户向api.example.com的根目录发出请求，会得到这样一个文档。

{"link": {
    "rel":   "collection https://www.example.com/zoos",//路径与本API的关系
    "href":  "https://api.example.com/zoos", //API路径
    "title": "List of zoos", //标题
    "type":  "application/vnd.yourformat+json" //返回类型
}}

例子https://api.github.com/

11.0 其他

API身份证认真使用Oauth 2.0http://www.ruanyifeng.com/blog/2014/05/oauth_2_0.html 尽量使用JSON

参考链接

阮一峰: http://www.ruanyifeng.com/blog/2014/05/restful_api.html

project

Comments