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(超媒体作为应用状态的引擎)
【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 被坑几百块钱后,我竟然真的恢复了删除的微信聊天记录!
· 没有Manus邀请码?试试免邀请码的MGX或者开源的OpenManus吧
· 【自荐】一款简洁、开源的在线白板工具 Drawnix
· 园子的第一款AI主题卫衣上架——"HELLO! HOW CAN I ASSIST YOU TODAY
· Docker 太简单,K8s 太复杂?w7panel 让容器管理更轻松!
2020-10-27 CSS 背景