API

**API（Application Programming Interface）**应用程序编程接口

可以把API理解为程序与程序之间通信的桥梁,其本质就是一个函数而已.另外,API的使用也是有章法的,它的规则由(比如数据输入和输出的格式)API提供方制定.

何为RESTful API

RESTful API经常也被叫做REST API ,它是基于REST构建的API. 举个例子 可以一眼从下面两个例子知道它们是干什么用的.这就是RESTful API的强大指出

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

RESTful API 可以让你看到 URL+Http Method 就知道这个URL是干什么的,让你看到了 HTTP 状态码 (status code) 就知道请求结果如何

我们在开发过程中设计API的时候也应该至少要满足 RESTful API 的最基本要求(比如接口中尽量使用名词,使用 POST 请求创建资源, DELETE 请求删除资源等等,示例: Get /notes/id: 获取某个制定id的笔记的意思)

解读 REST

REST 是 Epresentational State Transfer 的缩写,翻译过来是"表现层状态转化"

这样理解起来很晦涩,实际上REST的全称是 Resource Representational State Transfer, 直白地翻译过来就是 "资源"在网络传输中以某种"表现形式"进行"状态转移". 如果还是不能理解,继续往下看

我们分别对上面的概念进行解读,以便加深理解

• 资源(Resouse):我们可以把真实的对象数据称为资源.一个资源既可以是一个集合,也可以是单个个体.比如我们的班级 classes 是代表一个集合形式的资源,而特定的 class 代表单个个体资源.每一种资源都有特定的 URI (统一资源标识符) 与之对应,如果我们需要获取这个资源,访问这个 URI 就可以了,比如获取特定的班级: /class/12. 另外,资源也可以包含子资源,比如/calssws/classid/teachers 列出某个指定班级的所有老师的信息
• 表现形式(Representational): 资源是一种信息实体,它可以有多种外在表现形式.我们把"资源"具体呈现出来的形式比如 json, xml, image, txt 等等叫做它的"表现层/表现形式"
• 状态转移(State Transfer): 通俗的讲是 REST中的状态转移更多地描述的服务器端资源的状态,比如你通过增删改查引起资源状态的变化

综合上面的解释,我们总结一下什么是RESTful架构

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

RESTful API 规范

动作

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

路径（接口命名）

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

1. 网址中不能有动词，只能有名词，API 中的名词也应该使用复数。 因为 REST 中的资源往往和数据库中的表对应，而数据库中的表都是同种记录的"集合"（collection）。如果 API 调用并不涉及资源（如计算，翻译等操作）的话，可以用动词。比如：GET /calculate?param1=11&param2=33 。
2. 不用大写字母，建议用中杠 - 不用下杠 _ 。比如邀请码写成 invitation-code而不是 invitation_code 。
3. 善用版本化 API。当我们的 API 发生了重大改变而不兼容前期版本的时候，我们可以通过 URL 来实现版本化，比如 http://api.example.com/v1、http://apiv1.example.com 。版本不必非要是数字，只是数字用的最多，日期、季节都可以作为版本标识符，项目团队达成共识就可。
4. 接口尽量使用名词，避免使用动词。 RESTful API 操作（HTTP Method）的是资源（名词）而不是动作（动词）。

Talk is cheap！来举个实际的例子来说明一下吧！现在有这样一个 API 提供班级（class）的信息，还包括班级中的学生和教师的信息，则它的路径应该设计成下面这样。

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}：删除某个指定班级下的指定的老师的信息

理清资源的层次结构，比如业务针对的范围是学校，那么学校会是一级资源:/schools，老师: /schools/teachers，学生: /schools/students 就是二级资源。

状态码（Status Codes）

状态码范围：