附录C　RESTful API

1. 什么是REST

REST（Representational State Transfer，简称REST）描述了一个架构样式的网络系统，比如 web 应用程序。它首次出现在 2000 年 Roy Fielding 的博士论文中。REST倾向于用更加简单轻量的方法设计和实现Web服务。值得注意的是REST并没有一个明确的标准，而更像是一种设计的风格。

2. 什么是JSON

JSON(JavaScript Object Notation) 是一种轻量级的数据交换格式。它采用完全独立于编程语言的文本格式来存储和表示数据。简洁和清晰的层次结构使得 JSON 成为理想的数据交换语言。 易于人阅读和编写，同时也易于机器解析和生成，并有效地提升网络传输效率。

JSON 键值对是用来保存 JS 对象的一种方式，和 JS 对象的写法也大同小异，键/值对组合中的键名写在前面并用双引号 "" 包裹，使用冒号 : 分隔，然后紧接着值。例如：

{"firstName": "Brett", "lastName": "McLaughlin"}

和普通的 JS 数组一样，JSON 表示数组的方式也是使用方括号 []。

{ 
  "people":[
    {
      "firstName": "Brett",
      "lastName":"McLaughlin"
    },
    {
      "firstName":"Jason",
      "lastName":"Hunter"
    }
  ]
}

3. RESTful API

RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。一个简明的教程可以参看阮一峰老师的 RESTful API设计指南。此处给出设计要点：

a) 在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数。 举例来说，有一个API提供英雄（hero）的信息，还包括用户（user）的信息，则它的路径应该设计成下面这样。

https://api.example.com/heroes
https://api.example.com/users

b) 对于资源的具体操作类型，由HTTP动词表示。 常用的HTTP动词有下面五个（括号里是对应的SQL命令）。

• GET（SELECT）：从服务器取出资源（一项或多项）。
• POST（CREATE）：在服务器新建一个资源。
• PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
• PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。
• DELETE（DELETE）：从服务器删除资源。
  还有两个不常用的HTTP动词。
• HEAD：获取资源的元数据。
• OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。

c) 状态码（Status Codes） 服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）。

• 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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

下面是一些例子。

• GET /heroes：列出所有英雄
• POST /heroes：新建一个英雄
• GET /heroes/ID：获取某个指定英雄的信息
• PUT /heroes/ID：更新某个指定英雄的信息（提供该英雄的全部信息）
• PATCH /heroes/ID：更新某个指定英雄的信息（提供该英雄的部分信息）
• DELETE /heroes/ID：删除某个英雄

可以使用 POSTMAN (chrome) 或 RESTClient (Firefox) 来测试RESTful API。