Restful API规范

1.0 restful规范

restful规范是前端与后台进行通讯的一种规范,使用这个规范可以使前后端开发更方便。

1.1 协议

采用http或https协议。

1.2 数据传输格式

数据传输的格式应该都采用json,而不使用XML。

1.3 urL链接

url链接不能有动词,只能有名词,并且对于一些名词,如果出现复数,应该在后面加s

1.4 http请求方法

  • GET:从服务器上获取资源
  • POST:在服务器上新建一个资源
  • PUT:在服务器上更新资源,客户端提供所有改变后的数据
  • PATCH:在服务器上更新资源,客户端只提供需要改变的属性
  • DELETE:从服务器上删除资源
#示例:
GET /users/ :获取所有用户
POST /user/:新建一个用户
GET /user/id/ :根据id获取一个用户
PUT /user/id :更新某个id的用户信息,(需要提供用户所有信息)
PATCH /user/id/: 更新某个id的用户信息(只需要提供需要改变的信息)
DELETE /user/id/:删除一个用户

2.0 状态码

状态码描述
200服务器成功响应请求
400用户发出的请求有错误,服务器没有进行新建或修改数据的操作
401用户没有权限访问这个请求
403因为某些原因禁止访问这个请求
404用户发送的请求url不存在
406用户的请求不被服务器接收,
500服务器内部错误,如出现了bug