如何设计RESTful API

每次开工前,设计API也是十分重要的一个环节,现在RESTful API大行其道,那么如何才能设计出好的RESTful API呢,也就是说我们在设计RESTful API需要遵循哪些原则呢?

1、使用名词,别使用动词

我们知道RESTful API是一种面向资源(resource)设计的API,那么既然是面向资源,那自然用名词更合适,这个比较好理解吧。

/computers #推荐
/run       #不推荐

2、既然用名词,那就用名词的复数形式,当然不可数名词可以不变形

感觉有点在讲英语语法,这样做的目的其实就是为了避免与单数搞混淆,为了方便起见,索性都用复数。再多提一点,这里尽量用一个单词表示资源,不要用多个单词,然后中间加个下划线,比如/student_name/这样是不推荐的,如果是参数的话,这个可以,比如

/products/{product_id}/versions

3、用层级关系表示父子资源

啥意思呢,就比如

  • 1
    点赞
  • 9
    收藏
    觉得还不错? 一键收藏
  • 2
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值