RESTful接口详解

一、Rest架构的主要原则：

1、网络上的所有事物都被抽象为资源
2、每个资源都有一个唯一的资源标识符
3、同一个资源具有多种表现形式(xml,json等)
4、对资源的各种操作不会改变资源标识符
5、所有的操作都是无状态的

二、为什么会有restful接口

在Restful之前的操作：
http://127.0.0.1/user/query/1 GET 根据用户id查询用户数据
http://127.0.0.1/user/save POST 新增用户
http://127.0.0.1/user/update POST 修改用户信息
http://127.0.0.1/user/delete/1 GET/POST 删除用户信息

RESTful用法：
http://127.0.0.1/user/1 GET 根据用户id查询用户数据
http://127.0.0.1/user POST 新增用户
http://127.0.0.1/user PUT 修改用户信息
http://127.0.0.1/user DELETE 删除用户信息

之前的操作是没有问题的,大神认为是有问题的,有什么问题呢?你每次请求的接口或者地址,都在做描述,例如查询的时候用了query,新增的时候用了save,其实完全没有这个必要,我使用了get请求,就是查询.使用post请求,就是新增的请求,我的意图很明显,完全没有必要做描述,这就是为什么有了restful.

三、实际开发中常见的规范如下：

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

接口尽量使用名词，禁止使用动词。下面是一些例子：
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：删除某个指定班级下的指定的老师的信息
反例：
/getAllclasses
/createNewclass
/deleteAllActiveclasses
理清资源的层次结构，比如业务针对的范围是学校，那么学校会是一级资源:/schools，老师: /schools/teachers，学生: /schools/students 就是二级资源。

四 API接口设计六要素

https://segmentfault.com/a/1190000023874343
https://www.jianshu.com/p/7893169a7c93