Restful规范

Posted guanxiying

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Restful规范相关的知识,希望对你有一定的参考价值。

Restful规范

什么是Restful规范?

Restful规范就是一个定义web api接口的规范,它及其适用于前后端分离的情况

Resetful规范十条

  1. 数据的安全保障:推荐采用https协议,提高数据交互时的安全性
  2. 接口的特征表现:便于人一眼就看出这是一个接口,推荐使用api关键字表示接口url
  3. 多数据版本共存:当需要改变接口内容时不要直接修改已经运作的接口而是得重新写一个新得接口作为原来的接口的升级版,并且再url中标识出数据的版本(api/v1 api/v2)
  4. 数据即资源接口作为前后端交互的媒介其交互的数据又被叫做资源,推荐使用名词或者名词的复数形式,对于某些特殊接口,我们可以使用动词(api/books api/login)
  5. 资源操作由请求方式决定:资源的操作我们直接通过提交的请求方式来决定(get、post、put/patch、delete)
  6. 过滤:我们可以再url上传参的形式传递搜索条件
  7. 响应状态码:200、201(创建成功)、301(永久重定向)、302(临时重定向)、403(请求无权限)、404(请求路径不存在)、405(请求方法不存在)、500(服务器异常)
  8. 错误处理:应当返回错误信息
  9. 返回结果:更具不同的请求以及请求得到的数据返回不同的结果
  10. 需要url请求的资源需要访问资源的请求链接:返回结果中提供链接,连向其他API方法,使得用户不查文档,也知道下一步应该做什么

以上是关于Restful规范的主要内容,如果未能解决你的问题,请参考以下文章

RESTful规范

Restful规范

RESTful 接口规范

Restful接口规范

RESTful API设计规范收集

RestFul架构