RESTful接口规范

RESTful 是什么#

Restful 指的是遵循 REST 架构风格的 API 接口服务，而 REST（REpresentational State Transfer，表述性状态转换）是一种软件架构风格。

它解决的是”接口怎么起名字”的问题：

传统风格 url	请求方式	含义	备注
`/user/getById?id=1`	GET	查询 id 为 1 的用户	不规范、难维护
`/user/saveUser`	POST	新增用户
`/user/updateUser`	POST	修改用户
`/user/deleteUser?id=1`	GET	删除 id 为 1 的用户

Note

两个容易踩的点： ① REST 是风格、是约定，不是规定——约定可以打破。 ② 描述”功能模块”通常用复数形式（加 s）表示这一类资源而非单个资源：users、books、items。

填空答案（做完再点开）

REpresentational State Transfer / 表述性状态转换 / 架构风格　2. URL / HTTP 动词　3. 查询 / 新增 / 修改 / 删除　4. 复数　5. 风格 / 可以

2-1 把 /book/getBookById?id=5、/book/addBook、/book/delete?id=5 三个传统接口改写成 REST 风格
2-2 一个”学生管理”系统要支持：查列表、查单个、新增、修改、删除，写出 5 个 REST 接口（路径 + 方式）
2-3 为什么 DELETE 用 /users/1 而不是 /users/delete/1？（用”URL 定位资源”这句话解释）

参考答案（做完再点开）

2-1

1
GET    /books/5      查询 id 为 5 的图书
2
POST   /books        新增图书
3
DELETE /books/5      删除 id 为 5 的图书

2-2

1
GET    /students        查询列表
2
GET    /students/{id}   查询单个
3
POST   /students        新增
4
PUT    /students/{id}   修改
5
DELETE /students/{id}   删除

2-3 因为 URL 只负责定位资源（“要操作 id 为 1 的那个用户”），“要做什么”由 HTTP 动词（DELETE）表达。把动作塞进 URL 里（/users/delete/1）就退化成了传统风格，又多又乱。