API接口规范
2020-10-10 11:40:13 1 举报
一张图描述REST API规范
作者其他创作
大纲/内容
POST创建
PUT更新
Request HASH
返回 JSON 格式HTTP/1.1 2xx/4xx/5xxContent-Type: application/json{ \"stataus\": \"succeed/fail\
5xx 服务器端错误500 Internal Server Error:客户端请求有效,服务器处理时发生了意外。503 Service Unavailable:服务器无法处理请求,一般用于网站维护状态。
Data Write
Data Read
安全性
GET读取
访问版本控制
Data Synchronism
Request permission - 请求权限
Request limits - 请求流量限制
Cache
接收
X-HTTP-Method-Override
Data encryption - 数据加密
2xx 返回正常GET: 200 OK POST: 201 CreatedPUT: 200 OKPATCH: 200 OKDELETE: 204 No Content
Client IP - IP白名单
请求格式[地址]/[版本]/[逻辑分组]/[请求]*逻辑分组:尽量保持名词且一组*请求: 务必保持名词单数表示单一数据请求,复数表示数据集合请求
DELETE删除
数据一致性
访问负载平衡
4xx 客户端错误400 Bad Request:服务器不理解客户端的请求,未做任何处理。401 Unauthorized:用户未提供身份验证凭据,或者没有通过身份验证。403 Forbidden:用户通过了身份验证,但是不具有访问资源所需的权限。404 Not Found:所请求的资源不存在,或不可用。405 Method Not Allowed:用户已经通过身份验证,但是所用的 HTTP 方法不在他的权限之内。410 Gone:所请求的资源已从这个地址转移,不再可用。415 Unsupported Media Type:客户端要求的返回格式不支持。比如,API 只能返回 JSON 格式,但是客户端要求返回 XML 格式。422 Unprocessable Entity :客户端上传的附件无法处理,导致请求失败。429 Too Many Requests:客户端的请求次数超过限额。
PATCH部分更新
Token - 令牌
数据查询
0 条评论
下一页