restful规范

感情迁移 提交于 2020-02-13 04:30:24

一.什么是restful规范

  • REST与技术无关,代表的是一种软件架构风格,REST是Representational State Transfer的简称,中文翻译为“表征状态转移”
  • REST从资源的角度类审视整个网络,它将分布在网络中某个节点的资源通过URL进行标识,客户端应用通过URL来获取资源的表征,获得这些表征致使这些应用转变状态
  • 所有的数据,不过是通过网络获取的还是操作(增删改查)的数据,都是资源,将一切数据视为资源是REST区别与其他架构风格的最本质属性
  • 对于REST这种面向资源的架构风格,有人提出一种全新的结构理念,即:面向资源架构(ROA:Resource Oriented Architecture)

 

二.restful的十条规范

重要规范:

  1.路径,视网络上任何东西都是资源,均使用名词表示(可复数)

  127.0.0.1/get_all_book/ 

 

  2.method,通过请求方式来表示进行的操作 127.0.0.1/books/ get请求:表示获取所有图书

   127.0.0.1/books/1 get请求:表示获取id为1的图书

   127.0.0.1/books/ post请求:表示新增一本书

   127.0.0.1/books/ delete请求:表示删除一本书

   127.0.0.1/books/ put/patch请求:表示修改一本书

 

仅需了解的:

  3.API与用户的通信协议,总是使用HTTPs协议

  4.域名 https://api.example.com :尽量将API部署在专用域名(会存在跨域问题)

    https://example.org/api/:API很简单(推荐使用)

  5.版本 -https://api.example.com/v1/ -把版本号放在请求头中 127.0.0.1/book/1

  6.过滤,通过在url上传参的形式传递搜索条件

  7.状态码 1 开头:服务器正在处理    2 开头:服务器处理成功    3 开头:重定向

      由4 开头:客户端错误    5 开头:服务器错误       注意:在返回的数据中携带状态码

  8.错误处理,应返回错误信息,error当做key

  9.返回结果针对不同操作,返回数据格式要求

  10.返回结果中提供链接

标签
易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!