水下功夫做透,水上才能顺风顺水。

REST API

REST API规范
编写REST API,实际上就是编写处理HTTP请求的async函数,不过,REST请求和普通的HTTP请求有几个特殊的地方:
(1)REST请求仍然是标准的HTTP请求,但是,除了GET请求外,POST、PUT等请求的body是JSON数据格式,请求的Content-Type为application/json;
(2)REST响应返回的结果是JSON数据格式,因此,响应的Content-Type也是application/json。
(3)REST规范定义了资源的通用访问格式,虽然它不是一个强制要求,但遵守该规范可以让人易于理解。

 


RESTFul API的一些最佳实践原则:
使用HTTP动词表示增删改查资源, GET:查询,POST:新增,PUT:更新,DELETE:删除
返回结果必须使用JSON
HTTP状态码,在REST中都有特定的意义:200,201,202,204,400,401,403,500。比如401表示用户身份认证失败,403表示你验证身份通过了,但这个资源你不能操作。
API必须有版本的概念,v1,v2,v3
使用Token令牌来做用户身份的校验与权限分级,而不是Cookie。
url中大小写不敏感,不要出现大写字母
使用 - 而不是使用 _ 做URL路径中字符串连接。

posted @ 2020-05-25 08:14  北方寒士  阅读(451)  评论(0编辑  收藏  举报