REST API

一 API是什么

API（Application Programming Interface）：不仅是后端系统暴露的接口，像框架中提供的方法也属于 API 的范畴。

• 通过电商网站搜索某某商品，电商网站的前端就调用了后端提供了搜索商品相关的 API。
• 你使用 JDK 开发 Java 程序，想要读取用户的输入的话，你就需要使用 JDK 提供的 IO 相关的 API。

API 是程序与程序之间通信的桥梁，其本质就是一个函数，而且它的规则由（比如数据输入和输出的格式）API 提供方制定。

二 RESTful API又是什么

RESTful API 经常也被叫做 REST API，它是基于 REST 构建的 API。RESTful API 可以让你看到 URL+Http Method 就知道这个 URL 是干什么的，让你看到了 HTTP 状态码（status code）就知道请求结果如何。

GET    /classes：列出所有班级
POST   /classes：新建一个班级

三 解读REST

REST 的全称是 Resource Representational State Transfer ，直白地翻译过来就是 “资源”在网络传输中以某种“表现形式”进行“状态转移” 。涉及的概念如下：

• 资源（Resource） ：可以把真实的对象数据称为资源。一个资源既可以是一个集合，也可以是单个个体。比如班级 classes 是代表一个集合形式的资源，而特定的 class 代表单个个体资源。每一种资源都有特定的
  URI（统一资源标识符）与之对应，如果需要获取这个资源，访问这个 URI 就可以了。
• 表现形式（Representational）：“资源"是一种信息实体，它可以有多种外在表现形式。把"资源"具体呈现出来的形式比如 json，xml，image,txt 等等叫做它的"表现层/表现形式”。
• 状态转移（State Transfer） ： REST 中的状态转移更多地描述的服务器端资源的状态，比如通过增删改查（通过 HTTP 动词实现）引起资源状态的改变。

总结以下RESTful架构：

• 每一个 URI 代表一种资源；
• 客户端和服务器之间，传递资源的某种表现形式比如 json，xml，image,txt 等等；
• 客户端通过特定的 HTTP 动词，对服务器端资源进行操作，实现"表现层状态转化"。

四 RESTful API 规范

4.1 动作

• GET：请求从服务器获取特定资源。如：GET /classes（获取所有班级）
• POST：在服务器上创建一个新的资源。如：POST /classes（创建班级）
• PUT：更新服务器上的资源（客户端提供更新后的整个资源）。如：PUT /classes/12（更新编号为 12 的班级
• DELETE：从服务器删除特定的资源。如：DELETE /classes/12（删除编号为 12 的班级）
• PATCH：更新服务器上的资源（客户端提供更改的属性，可以看做作是部分更新）。

4.2 路径（接口命名）

路径又称"终点"（endpoint），表示 API 的具体网址。实际开发中常见的规范如下：

• 网址中不能有动词，只能有名词，API 中的名词也应该使用复数。
• 不用大写字母，建议用中杠 - 不用下杠 _ 。
• 善用版本化 API。比如 http://api.example.com/v1、http://apiv1.example.com 。
• 接口尽量使用名词，避免使用动词。 RESTful API 操作（HTTP Method）的是资源（名词）而不是动作（动词）。

GET    /classes：列出所有班级
POST   /classes：新建一个班级
GET    /classes/{classId}：获取某个指定班级的信息
PUT    /classes/{classId}：更新某个指定班级的信息（一般倾向整体更新）
PATCH  /classes/{classId}：更新某个指定班级的信息（一般倾向部分更新）
DELETE /classes/{classId}：删除某个班级
GET    /classes/{classId}/teachers：列出某个指定班级的所有老师的信息
GET    /classes/{classId}/students：列出某个指定班级的所有学生的信息
DELETE /classes/{classId}/teachers/{ID}：删除某个指定班级下的指定的老师的信息

4.3 过滤信息（Filtering）

如果我们在查询的时候需要添加特定条件的话，建议使用 url 参数的形式。比如实现分页查询时：

GET    /classes?page=1&size=10 //指定第1页，每页10个数据

4.4 状态码（Status Codes）

• 2xx：成功。200 成功，201 创建。
• 3xx：重定向。301 永久重定向，304 资源未修改。
• 4xx：客户端错误。400 错误请求，401 未授权， 403 禁止访问，404 未找到，405 请求方法不对。
• 5xx：服务器错误。500 服务器错误，502 网关错误，504 网关超时。

五 RESTful 规范写法 HATEOAS

RESTful API 最好是 Hypermedia，即返回结果中提供链接，连向其他 API 方法，使得用户不查文档，也知道下一步应该做什么。
比如，当用户向 api.example.com 的根目录发出请求，会得到这样一个返回结果

{"link": {
  "rel":   "collection https://www.example.com/classes",
  "href":  "https://api.example.com/classes",
  "title": "List of classes",
  "type":  "application/vnd.yourformat+json"
}}

文档中有一个 link 属性，用户读取这个属性就知道下一步该调用什么 API 了。rel 表示这个 API 与当前网址的关系（collection 关系，并给出该 collection 的网址），href 表示 API 的路径，title 表示 API 的标题，type 表示返回类型。
Hypermedia API 的设计被称为HATEOAS。