Restful接口的好处是:统一接口、URI。方便接口管理 请求被分为以下几种
- get:查询请求
- post:新增请求
- put:更新请求
- delete:删除请求
请求特点为两类
- get和delete请求参数写法是一致的(url参数拼接,无请求主体)
- post和put请求参数写法是一致的(data参数,有请求主体 xhr.send(data))
响应行为规范
- get请求成功时,返回对应的数据,及状态码200
- put请求成功时,返回修改的数据,及状态码200
- post请求成功时,返回新增的数据,及状态码201
- delete请求成功时,不返回数据,状态码204
- 请求数据有错返回 状态码400
- 用户认证信息错误 状态码401
- 用户无权限进入 状态码403
- 前端请求找不到 状态码404
URL规则规范 示例:http(s)😕/域名/项目名/{version}/{model}/{name}
- {version}代表版本号
- {model}是某一功能的接口{name}
- name代表model所在功能下的Restful接口名称
发送数据与返回 统一采用JSON格式数据
常用状态码
状态码 | 返回信息 | 原因 |
---|
200 | OK | 请求成功。一般用于get,put请求 | 201 | Created | 已创建。成功请求并创建了新的资源 | 204 | No Content | 无内容。服务器成功处理,但未返回内容 | 400 | Bad Request | 请求语法错误,服务器无法理解 | 401 | Unauthorized | 请求要求用户的身份认证 | 403 | Forbidden | 服务器拒绝执行客户端的请求 | 404 | Not Found | 服务器无法根据请求找到网页 | 405 | Method Not Allowed | 客户端请求中的方法被禁止 | 500 | Internal Server Error | 服务器内部错误 | 502 | Bad Gateway | 远端服务器接收无效请求 | – | – | – |
|