码迷,mamicode.com
首页 > Windows程序 > 详细

Restful架构API编码规范

时间:2018-12-09 14:02:40      阅读:222      评论:0      收藏:0      [点我收藏+]

标签:集合   boot   fse   记录   xxxxx   全局   属性   后台   部署   

Restful API

目前比较成熟的一套互联网应用程序的API设计理论

一、协议

  • API与用户的通信协议,总是使用HTTPs协议。

二、域名

  • 应该尽量将API部署在专用域名之下。
https://api.xxxxxx.cn/
https://xxxxxx.cn/api/

三、版本(Versioning)

  • 应该将API的版本号放入URL。
https://xxxxxx.cn/api/v1/
  • 另一种做法是,将版本号放在HTTP头信息中,但不如放入URL方便和直观。

四、路径(Endpoint)

  • 在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,==只能有名词==,而且所用的名词往往与数据库的表格名对应。一般来说,数据库中的表都是同种记录的"集合"(collection),所以API中的名词也应该使用==复数==。
https://xxxxxx.cn/api/v1/users
https://xxxxxx.cn/api/v1/reports
https://xxxxxx.cn/api/v1/jobs
  • URL中大小写不敏感,不要出现大写字母
  • _ 和 - 作为API URL连接单词都可以,但是驼峰命名法就算了

五、HTTP动词

  • 对于资源的具体操作类型,由HTTP动词表示。
  • 常用的HTTP动词有下面五个(括号里是对应的SQL命令)。
HTTP动词 描述
GET(SELECT) 从服务器取出资源(一项或多项)。
POST(CREATE) 在服务器新建一个资源。
PUT(UPDATE) 在服务器更新资源(客户端提供改变后的完整资源)。
PATCH(UPDATE) 在服务器更新资源(客户端提供改变的属性)。
DELETE(DELETE) 从服务器删除资源。
GET     /users:            列出所有的用户

POST    /users:            新建一个用户

GET     /users/${id}:      获取某个用户的信息

PUT     /users/${id}:      更新某个用户的信息(提供该用户的全部信息)

PATCH   /users/${id}:      更新某个指定用户的信息(提供该用户的部分信息)

DELETE  /users/${id}:      删除某个用户

六、过滤信息(Filtering)

  • 如果记录数量很多,服务器不可能都将它们返回给用户。API应该提供参数,过滤返回结果。
?limit=10:指定返回记录的数量

?offset=10:指定返回记录的开始位置。

?page=2&per_page=100:指定第几页,以及每页的记录数。

?sortby=name&order=asc:指定返回结果按照哪个属性排序,以及排序顺序。

?user_id=1:指定筛选条件

七、状态码(Status Codes)

  • 服务器向用户返回的状态码和提示信息,常见的有以下一些(方括号中是该状态码对应的HTTP动词)。
200 OK - [GET]:服务器成功返回用户请求的数据,该操作是幂等的(Idempotent)。
201 CREATED - [POST/PUT/PATCH]:用户新建或修改数据成功。
202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务)
204 NO CONTENT - [DELETE]:用户删除数据成功。
400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作,该操作是幂等的。
401 Unauthorized - [*]:表示用户没有权限(令牌、用户名、密码错误)。
403 Forbidden - [*] 表示用户得到授权(与401错误相对),但是访问是被禁止的。
404 NOT FOUND - [*]:用户发出的请求针对的是不存在的记录,服务器没有进行操作,该操作是幂等的。
406 Not Acceptable - [GET]:用户请求的格式不可得(比如用户请求JSON格式,但是只有XML格式)。
410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误。
500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。

八、错误处理(Error handling)

  • 如果状态码是4xx,就应该向用户返回出错信息。一般来说,返回的信息中将error作为键名,出错信息作为键值即可。
{
    error: "Invalid API key"
}
  • Spring Boot项目中通常需要全局捕获异常,统一处理。
  • Spring全局异常处理并不能处理Filter中的异常。

九、返回结果

  • 针对不同操作,服务器向用户返回的结果应该符合以下规范。
GET /collection:返回资源对象的列表(数组)
GET /collection/resource:返回单个资源对象
POST /collection:返回新生成的资源对象
PUT /collection/resource:返回完整的资源对象
PATCH /collection/resource:返回完整的资源对象
DELETE /collection/resource:返回一个空文档
  • 可以自定义返回结果包装类、返回结果状态码和提示信息等。
{
    "code":100200,
    "msg":"success",
    "data":null,
    "extra":null
}

十、接口安全问题

  • API的身份认证应该使用OAuth 2.0框架。

Restful架构API编码规范

标签:集合   boot   fse   记录   xxxxx   全局   属性   后台   部署   

原文地址:https://www.cnblogs.com/Grand-Jon/p/10090691.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!