RESTful API

  1. 协议：以HTTPS为主

  2. 域名：使用专用域名

    1. https://api.example.com
  1. 版本
    1. https://api.example.com/v1/
  1. 路径:不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应，名词为复数
    1. https://api.example.com/v1/zoos
    2. https://api.example.com/v1/animals
    3. https://api.example.com/v1/employees
  1. HTTP动词
    1. GET（SELECT）：从服务器取出资源（一项或多项）。
    2. POST（CREATE）：在服务器新建一个资源。
    3. PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
    4. PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。
    5. DELETE（DELETE）：从服务器删除资源。
    6. HEAD：获取资源的元数据。
    7. OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。
  • 例子
    1. GET /zoos：列出所有动物园
    2. POST /zoos：新建一个动物园
    3. GET /zoos/ID：获取某个指定动物园的信息
    4. PUT /zoos/ID：更新某个指定动物园的信息（提供该动物园的全部信息）
    5. PATCH /zoos/ID：更新某个指定动物园的信息（提供该动物园的部分信息）
    6. DELETE /zoos/ID：删除某个动物园
    7. GET /zoos/ID/animals：列出某个指定动物园的所有动物
    8. DELETE /zoos/ID/animals/ID：删除某个指定动物园的指定动物
  1. 过滤信息
    1. ?limit=10：指定返回记录的数量
    2. ?offset=10：指定返回记录的开始位置。
    3. ?page=2&per_page=100：指定第几页，以及每页的记录数。
    4. ?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
    5. ?animal_type_id=1：指定筛选条件

参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。比如GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的，区别在于获取粒度，第一个是获取所有，第二是获取指定动物园

  1. 状态码
    1. 200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
    2. 201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
    3. 202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
    4. 204 NO CONTENT - [DELETE]：用户删除数据成功。
    5. 400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
    6. 401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
    7. 403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
    8. 404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
    9. 406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
    10. 410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
    11. 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
    12. 500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。
  1. 错误处理
    1. {
    2.  error: "Invalid API key"
    3. }
  1. 返回结果
    1. GET /collection：返回资源对象的列表（数组）
    2. GET /collection/resource：返回单个资源对象
    3. POST /collection：返回新生成的资源对象
    4. PUT /collection/resource：返回完整的资源对象
    5. PATCH /collection/resource：返回完整的资源对象
    6. DELETE /collection/resource：返回一个空文档
  1. hupermedia api
  1. {
  2.   "link": {
  3.     "rel":   "collection https://www.example.com/zoos",
  4.      "href":  "https://api.example.com/zoos",
  5.      "title": "List of zoos",
  6.      "type":  "application/vnd.yourformat+json"
  7.   }
  8. }