Restful API

url参数

URL 参数是追加到 URL 上的一个名称/值对。参数以问号 (?) 开始并采用 name=value 的格式。如果存在多个 URL 参数,则参数之间用一个 (&) 符隔开

Restful API设计

  • 尽量不用url参数
  • 用HTTP方法表示操作类型(使用post delete put/patch get做增删改查),充分利用HTTP方法的语义
怎样做到尽量不使用url参数?

传统API设计:/api/list?pageIndex=2
Restful API设计:/api/list/2

怎样利用HTTP方法的语义?

比如,通过用户的ID获取个人信息,显然要使用GET方法。按照传统API设计我们就这么写地址接口:https://www.imooc.com/api/http/getUser?id=1。
这个地址就可以当作前后端的一个接口,前后端通过这个地址完成通信,前端发送对这个地址的请求,后端把数据放到这个地址上

对于注册/修改/删除用户的接口,按照传统API设计就得这么来写

注册新用户,使用 POST 方法
https://www.imooc.com/api/http/addUser
修改一个用户,使用 POST 方法
https://www.imooc.com/api/http/modifyUser
删除一个用户,使用 POST 方法
https://www.imooc.com/api/http/deleteUser

我们对user的增删改查就是用了四种不同的接口,后端写起来会很麻烦

怎么避免这种麻烦?使用Restful接口设计,充分利用HTTP方法的语义

GET
https://www.imooc.com/api/http/user/1
POST
https://www.imooc.com/api/http/user
PUT
https://www.imooc.com/api/http/user/2
DELETE
https://www.imooc.com/api/http/user/3

接口设计的一样。但后端可以获取到前端的请求方式get/post/put/delete。后端如果获取到的前端方法是get,他就知道你前端是想获取到user的数据,获取的哪条数据,则由
http/user/1 user后面的参数来决定

接口设计的一样。后端通过获取到的不同的方法,来做不同的事情

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值