restful api接口设计风格以及思路

以一个开发者的角度来看,我们没有必要把rest这种思想跟理念搞得特别清楚,我们只需要大概知道它的规范即可,在工作中能够让接口规范起来,就达到目的了。restful可以理解为是rest思想风格的实现既然是在开发API接口,从正常角度分析来看,得有一套规范吧,就像框架一样会有条条框框个人认为,实现resftul api接口的规范做到几下几点就算是不错了1、规范URL在设计API时...
摘要由CSDN通过智能技术生成

以一个开发者的角度来看,我们没有必要把rest这种思想跟理念搞得特别清楚,我们只需要大概知道它的规范即可,在工作中能够让接口规范起来,就达到目的了。

restful 可以理解为是rest思想风格的实现

既然是在开发API接口,从正常角度分析来看,得有一套规范吧,就像框架一样会有条条框框

个人认为,实现resftul api接口的规范做到几下几点就算是不错了

1、规范URL

在设计API时,URL是资源的来源,也是API的源。

设置一个规范合理,符合restful风格的API是什么样的呢?它没有样子,只有思想

首先,要遵循动宾结构。

动词即为HTTP协议的请求方法,如:

GET 获取 \POST 新建\PUT 更新\DELETE 删除等(建议大写)

宾语,即可选名词,名词有单数和复数,规范建议用复数 

例子:获取所有订单

以前的API:https://xxx.com/getorders      (method: get)

restful api:https://xxx.com/orders?all=true (method: get)

上面前者的扩展性不够强,并且没有名词,不符合restful规范

后者用了orders名词复数,并且语义上很通俗易懂的告诉了客户端人员all=true,这是要拿所有的订单

如果要扩展,可以变换参数

2、状态码

HTTP1.0协议有很多状态码,在restful中,3开头的状态码是用不到了。

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值