避免本身写的 url 被diss！建议看看这篇RestFul API简明教程！

你们好我是 Guide 哥！这是个人第 210 篇优质原创！这篇文章主要分享了后端程序员必备的 RestFul API 相关的知识。

RestFul API 是每一个程序员都应该了解并掌握的基本知识，咱们在开发过程当中设计 API 的时候也应该至少要知足 RestFul API 的最基本的要求（好比接口中尽可能使用名词，使用 POST 请求建立资源，DELETE 请求删除资源等等，示例：GET /notes/id：获取某个指定 id 的笔记的信息）。

若是你看 RestFul API 相关的文章的话通常都比较晦涩难懂，包括我下面的文章也会提到一些概念性的东西。可是，实际上咱们平时开发用到的 RestFul API 的知识很是简单也很容易归纳！举个例子,若是我给你下面两个 url 你是否是立马能知道它们是干什么的！这就是 RestFul API 的强大之处！

RestFul API 能够你看到 url + http method 就知道这个 url 是干什么的，让你看到了 http 状态码（status code）就知道请求结果如何。

GET    /classs：列出全部班级
POST   /classs：新建一个班级

下面的内容只是介绍了我以为关于 RestFul API 比较重要的一些东西，欢迎补充。

1、重要概念

REST,即 REpresentational State Transfer 的缩写。这个词组的翻译过来就是"表现层状态转化"。这样理解起来甚是晦涩，实际上 REST 的全称是 Resource Representational State Transfe ，直白地翻译过来就是 “资源”在网络传输中以某种“表现形式”进行“状态转移” 。若是仍是不能继续理解，请继续往下看，相信下面的讲解必定能让你理解到底啥是 REST 。

咱们分别对上面涉及到的概念进行解读，以便加深理解，不过实际上你不须要搞懂下面这些概念，也能看懂我下一部分要介绍到的内容。不过，为了更好地能跟别人扯扯 “RestFul API”我建议你仍是要好好理解一下！

• 资源（Resource） ：咱们能够把真实的对象数据称为资源。一个资源既能够是一个集合，也能够是单个个体。好比咱们的班级 classs 是表明一个集合形式的资源，而特定的 class 表明单个个体资源。每一种资源都有特定的 URI（统一资源定位符）与之对应，若是咱们须要获取这个资源，访问这个 URI 就能够了，好比获取特定的班级：/class/12。另外，资源也能够包含子资源，好比 /classs/classId/teachers：列出某个指定班级的全部老师的信息
• 表现形式（Representational）："资源"是一种信息实体，它能够有多种外在表现形式。咱们把"资源"具体呈现出来的形式好比 json，xml，image,txt 等等叫作它的"表现层/表现形式"。
• 状态转移（State Transfer） ：你们第一眼看到这个词语必定会很懵逼？心里 BB：这尼玛是啥啊？ 大白话来讲 REST 中的状态转移更多地描述的服务器端资源的状态，好比你经过增删改查（经过 HTTP 动词实现）引发资源状态的改变。ps:互联网通讯协议 HTTP 协议，是一个无状态协议，全部的资源状态都保存在服务器端。

综合上面的解释，咱们总结一下什么是 RESTful 架构：

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

2、REST 接口规范

一、动做

• GET ：请求从服务器获取特定资源。举个例子：GET /classs（获取全部班级）
• POST ：在服务器上建立一个新的资源。举个例子：POST /classs（建立班级）
• PUT ：更新服务器上的资源（客户端提供更新后的整个资源）。举个例子：PUT /classs/12（更新编号为 12 的班级）
• DELETE ：从服务器删除特定的资源。举个例子：DELETE /classs/12（删除编号为 12 的班级）
• PATCH ：更新服务器上的资源（客户端提供更改的属性，能够看作做是部分更新），使用的比较少，这里就不举例子了。

二、路径（接口命名）

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

1. 网址中不能有动词，只能有名词，API 中的名词也应该使用复数。 由于 REST 中的资源每每和数据库中的表对应，而数据库中的表都是同种记录的"集合"（collection）。若是 API 调用并不涉及资源（如计算，翻译等操做）的话，能够用动词。 好比：GET /calculate?param1=11&param2=33
2. 不用大写字母，建议不用中杠 - 不用下杠 _ 好比邀请码写成 invitation-code而不是 invitation_code

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

接口尽可能使用名词，禁止使用动词。 下面是一些例子：

GET    /classs：列出全部班级
POST   /classs：新建一个班级
GET    /classs/classId：获取某个指定班级的信息
PUT    /classs/classId：更新某个指定班级的信息（通常倾向总体更新）
PATCH  /classs/classId：更新某个指定班级的信息（通常倾向部分更新）
DELETE /classs/classId：删除某个班级
GET    /classs/classId/teachers：列出某个指定班级的全部老师的信息
GET    /classs/classId/students：列出某个指定班级的全部学生的信息
DELETE classs/classId/teachers/ID：删除某个指定班级下的指定的老师的信息

反例：

/getAllclasss
/createNewclass
/deleteAllActiveclasss

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

三、过滤信息（Filtering）

若是咱们在查询的时候须要添加特定条件的话，建议使用 url 参数的形式。好比咱们要查询 state 状态为 active 而且 name 为 guidegege 的班级：

GET    /classs?state=active&name=guidegege

好比咱们要实现分页查询：

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

四、状态码（Status Codes）

状态码范围：

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

三 HATEOAS

RestFul 的极致是 hateoas ，可是这个基本不会在实际项目中用到。

上面是 RESTful API 最基本的东西，也是咱们平时开发过程当中最容易实践到的。实际上，RESTful API 最好作到 Hypermedia，即返回结果中提供连接，连向其余 API 方法，使得用户不查文档，也知道下一步应该作什么。

好比，当用户向 api.example.com 的根目录发出请求，会获得这样一个文档。

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

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

在 Spring 中有一个叫作 HATEOAS 的 API 库，经过它咱们能够更轻松的建立除符合 HATEOAS 设计的 API。

做者介绍: Github 70k Star 项目 JavaGuide（公众号同名） 做者。每周都会在公众号更新一些本身原创干货。公众hao后台回复“1”领取Java工程师必备学习资料+面试突击pdf。