概况
Restful强调的是接口模块的概念,每个模块都是独立的,每个模块的接口方法都是统一的和单一的,即CRUD方法组成。
1、尽量使用JSON,避免使用XML
2、要有版本号
- 将API的版本号放入URL https://api.example.com/v1/
- 版本号放在HTTP头信息中
3、名词
每个网址代表一种资源,所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。一般来说,数据库中的表都是同种记录的"集合",所以API中的名词也应该使用复数。
4、资源的具体操作类型,由HTTP动词表示
- GET(SELECT):从服务器取出资源(一项或多项)。
- POST(CREATE):在服务器新建一个资源。
- PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。
- PATCH(UPDATE):在服务器更新资源(客户端提供改变的属性)。
- DELETE(DELETE):从服务器删除资源。
5、返回消息
返回状态码,提示信息,内容
网友评论