RESTful API详解

简述

  REST ful API是符合REST风格的webAPI,REST是一种设计风格。全称是REpresentational State Transfer,中文叫表述性状态转移。

  用一句话来说,RESTful API就是:

  用URL定位资源,用HTTP动词描述操作

RESTful API的好处

  规范API设计

  增强API的可读性

  方便前后端协作

路径规范

路径只有名词

  URL中只能有名词(资源名),不能有动词,名词一般与数据库表名相对应

  例如:https://www.test.com/users

  而不是:https://www.test.com/addUsers

  动作体现在HTTP请求的类型上,例如我们用get请求访问 https://www.test.com/users 就包含了获取用户的含义

名词用复数

  资源名应该使用复数形式,使用users而不是user

资源ID放URL上

  资源ID应该作为路径的一部分,紧跟在资源后

  例如:https://www.test.com/users/1 

  而不是:https://www.test.com/users?id=1

  注意仅限id,查询参数请不要放在URL上

父资源应该在子资源前面

  如果users是父资源,accouts是子资源

  例如:https://www.test.com/users/1/accouts/3

  而不是:https://www.test.com/accouts/1/user/3

其他规范

  URL中统一使用小写字母

  使用 "-" 代替 "_"

  URL中不能包含文件的扩展名

  URL结尾不要包含 "/"

交互设计

  即使用不同HTTP请求方式代表增删改查的功能  

  GET——查

  POST——增

  DELETE——删

  PUT,PATCH——改

HATEOAS

  HATEOAS是比较高端的REST ful 设计风格,指在HTTP的返回数据中link其他可能需要动作的信息

  Hypermedia as the Engine of Application State(超媒体作为应用状态的引擎)

posted @ 2022-10-27 19:04  艾尔夏尔-Layton  阅读(364)  评论(0编辑  收藏  举报