RESTful API设计概要详解编程语言

1. 什么是REST

　　REST全称是Representational State Transfer，中文意思是表述（编者注：通常译为表征）性状态转移。 它首次出现在2000年Roy Fielding的博士论文中，Roy Fielding是HTTP规范的主要编写者之一。 他在论文中提到：“我这篇文章的写作目的，就是想在符合架构原理的前提下，理解和评估以网络为基础的应用软件的架构设计，得到一个功能强、性能好、适宜通信的架构。REST指的是一组架构约束条件和原则。” 如果一个架构符合REST的约束条件和原则，我们就称它为RESTful架构。

　　REST本身并没有创造新的技术、组件或服务，而隐藏在RESTful背后的理念就是使用Web的现有特征和能力， 更好地使用现有Web标准中的一些准则和约束。虽然REST本身受Web技术的影响很深， 但是理论上REST架构风格并不是绑定在HTTP上，只不过目前HTTP是唯一与REST相关的实例。 所以我们这里描述的REST也是通过HTTP实现的REST。

特点：

• REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”
• REST从资源的角度类审视整个网络，它将分布在网络中某个节点的资源通过URL进行标识，客户端应用通过URL来获取资源的表征，获得这些表征致使这些应用转变状态
• REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”
• 所有的数据，不过是通过网络获取的还是操作（增删改查）的数据，都是资源，将一切数据视为资源是REST区别与其他架构风格的最本质属性
• 对于REST这种面向资源的架构风格，有人提出一种全新的结构理念，即：面向资源架构（ROA：Resource Oriented Architecture）

1.协议

• API与用户的通信协议，总是使用HTTPs协议。

2.域名

• https://api.example.com                         尽量将API部署在专用域名（会存在跨域问题）
• https://example.org/api/                        API很简单

3.版本

• URL，如：https://api.example.com/v1/                     版本号放到url，如k8s的apiserver
• 将版本放到请求头中                                                  跨域时，引发发送多次请求

4.路径

路径又称”终点”（endpoint），表示API的具体网址。

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

https://api.example.com/v1/zoos 
https://api.example.com/v1/animals 
https://api.example.com/v1/employees

5.http方法

GET（SELECT）：从服务器取出资源（一项或多项）、安全且幂等。 
POST（CREATE）：在服务器新建一个资源、不安全且不幂等 
PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）、不安全但幂等 
PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。 
DELETE（DELETE）：从服务器删除资源、不安全但幂等 
HEAD：获取资源的元数据。 
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.过滤，通过在url上传参的形式传递搜索条件

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

7.状态码使用

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

8.错误处理

错误处理，状态码是4xx时，应返回错误信息，error当做key。

9.返回结果

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

10.超链接API

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

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

11.其他

（1）API的身份认证应该使用OAuth 2.0框架。

（2）服务器返回的数据格式，应该尽量使用JSON，避免使用XML。

参考：1.https://www.cnblogs.com/wupeiqi/articles/7805382.html

　　    2.https://blog.csdn.net/tjgamejx2/article/details/51011425

　　    3.http://www.ruanyifeng.com/blog/2014/05/restful_api.html