RESTURI约定-创建资源时的单数或复数名称怎么弄?

内容来源于 Stack Overflow,并遵循CC BY-SA 3.0许可协议进行翻译与使用

  • 回答 (10)
  • 关注 (0)
  • 查看 (137)

我对REST很陌生,我注意到在一些RESTful服务中,它们使用不同的资源URI来更新/获取/删除和创建。如

  • 创建-使用/resources用POST方法(观察复数)在某些地方使用/resources(单数)
  • 更新-使用/resources/123用放法
  • 利用/resources/123用GET方法

我对这个URI命名约定有点困惑。我们应该使用什么复数或单数来创建资源?

提问于
用户回答回答于

从API使用者的角度来看,端点应该是可预测的,所以

理想情况下.

  1. GET /resources应该返回资源列表。
  2. GET /resource应该返回一个400级别的状态代码。
  3. GET /resources/id/{resourceId}应该使用一个资源返回集合。
  4. GET /resource/id/{resourceId}应该返回一个资源对象。
  5. POST /resources应该批处理创建资源。
  6. POST /resource应该创建一个资源。
  7. PUT /resource应该更新资源对象。
  8. PATCH /resource应该只发布更改的属性来更新资源。
  9. PATCH /resources批处理更新资源时,只发布更改的属性。
  10. DELETE /resources应该删除所有资源;只是开玩笑:400状态代码
  11. DELETE /resource/id/{resourceId}

这种方法最灵活,功能最丰富,也是开发时间最长的方法。因此,如果您很匆忙(软件开发总是如此),只需指定端点resource或复数形式resources我更喜欢单数形式,因为它让你可以选择以编程的方式进行反思和评估,因为并非所有的复数形式都以‘s’结尾。

尽管如此,出于任何原因,最常用的实践开发人员选择的是使用复数形式。这是我最终选择的路线,如果您看一下流行的API,比如githubtwitter他们就是这么做的。

决定的一些标准可以是:

  1. 我的时间限制是什么?
  2. 我将允许我的消费者做什么操作?
  3. 请求和结果有效负载是什么样子的?
  4. 我希望能够在代码中使用反射并解析URI吗?

所以这取决于你。不管你做什么都是一致的。

热门问答

腾讯云广州一区DNS变更,需要怎么操作?

思潮澎湃轻描淡写的生活,但思潮澎湃
推荐
我也收到相关的通知了,这里分享下~ 2019年1月31日,腾讯云将对广州地区旧的基础网络DNS服务器(10.225.30.181、10.225.30.223)进行下线。在此期间,腾讯云提供最新的DNS服务器供您更新使用。 我们建议您尽快将DNS服务器配置进行更新,并且我们为您提供...... 展开详请

CMQ创建队列成功,紧接着发送消息,报队列不存在?

CreateQueue成功后,创建队列的时间为1s,您可以等待下在sendMessage

云呼叫中心只能用户自己开发吗?

腾讯云通信团队

腾讯 · 腾讯云通信团队 (已认证)

腾讯高级产品经理
推荐

目前呼叫中心只有API文档,需要用户自己开发。如果用户需要saas系统的呼叫中心可以使用智能外呼机器人:https://cloud.tencent.com/product/ccsr

ios端推流setRenderRotation无效?

西风

renzha.net · 站长 (已认证)

www.renzha.net
推荐

你有没有调整观众端表现,即通过对 LivePushConfig 中的homeOrientation设置项进行配置,它控制的是观众端看到的视频宽高比是16:9还是6:19,调整后的结果可以用播放器查看以确认是否符合预期。

腾讯云直播 CNAME 记录添加 的 值是多少???

西风

renzha.net · 站长 (已认证)

www.renzha.net
推荐
第一步:域名备案 控制台进行域名提交管理前,需对域名进行备案,详情请查看 域名备案 和 域名备案和配置常见问题 文档。 第二步:添加域名 在视频直播菜单栏内选择【域名管理】,在域名管理页面可以看到已创建域名、类型、状态、添加时间和操作。 可添加和管理的域名类型有播放域名和推流域...... 展开详请

【建议】【API】使用API创建子网的时候允许指定已有路由表?

推荐

控制台使用的是新的接口,批量创建子网,https://cloud.tencent.com/document/product/215/31960,可以指定路由表。terraform开发的时候是基于api2.0开发的,还没有这个接口,因此暂时无法使用

所属标签

扫码关注云+社区