RESTful API
RESTful API
RESTful API是一种特殊风格的接口,主要特点有如下几个:
- URL中的路径表示资源,路径中不能有动词,例如
create
,delete
,update
等这些都不能有 - 操作资源要与
HTTP
请求方法对应 - 操作结果要与
HTTP
响应状态码对应
规则示例:
操作 | 请求方法 | URL示例 | 返回 |
---|---|---|---|
新增歌曲 | POST | /song | 返回新生成的歌曲信息 |
删除歌曲 | DELETE | /song/10 | 返回一个空文档 |
修改歌曲 | PUT | /song/10 | 返回更新后的歌曲信息 |
修改歌曲 | PATCH | /song/10 | 返回更新后的歌曲信息 |
获取所有歌曲 | GET | /song | 返回歌曲列表数组 |
获取单个歌曲 | GET | /song/10 | 返回单个歌曲信息 |
请求方法:
GET(SELECT):从服务器取出资源(一项或多项)--幂等。
POST(CREATE):在服务器新建一个资源 --非幂等。
PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源) --幂等。
PATCH(UPDATE):在服务器更新资源(客户端提供改变的属性)--幂等。
DELETE(DELETE):从服务器删除资源 --幂等。
不常用的2个
HEAD:获取资源的元数据。
OPTIONS:获取信息,关于资源的哪些属性是客户端可以改变的(跨域检测一般会用这个请求)。
json-server
json-server本身是一个JS编写的工具包,可以快速搭建RESTful API
服务
接口测试工具
- apipost: https://www.apipost.cn/ (中文)
- pifox: https://www.apifox.cn/ (中文)
- postman: https://www.postman.com/ (英文)