带有子项的实体的API版本控制?

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

  • 回答 (1)
  • 关注 (0)
  • 查看 (25)

我正在将一些API端点迁移到更简洁的方式。但是我遇到了一些关于如何处理嵌套对象的问题。

例如:

我有一个对象Foo和一个Bar

Foo v1.0

{
  "field_one": "String",
  "field_two": "String"
}

Foo v1.1

{
  "field_one": "String",
  "field_two": "String",
  "field_three": "String"
}

Bar v1.0

{
  "foo": "Foo",
  "field_one": "String",
  "field_two": "String"
}

对于获取Foo版本的端点非常简单,是v1.0或者v1.1,但是如何处理端点Bar?对孩子的每次改变都应该为父母“生成”一个新版本?如果父母有多个版本化的孩子,如何处理?如果Bar有另一个孩子Baz有两个不同的版本,版本控制Bar将继续与孩子的迭代?

Bar v1.0 -> Foo v1.0
Bar v1.1 -> Foo v1.1
Bar v2.0 -> Foo v1.1 + Baz v1.0

如何让它变得如此简单,如果消费者想要Foo v1.1在他的整个应用程序中使用它,他知道Bar应该得到哪个版本?只是文档或背后有一些模式?

提问于
用户回答回答于

所有评论都对可能的解决方案有一些很好的反馈。您需要问的问题是您的嵌套资源是否包含在内遏制不允许资源被处理,因此,它根据其包含的父项进行版本控制。例如,考虑订单及其相关的订单项。订单项通常不应单独寻址。

如果您有相关的,但不同的寻址资源,任何一个资源应该直接提供相关的资源。这引入了耦合。在REST中解决这个问题的方法是使用HATEOAS。有许多方法可以实现HATEOAS,只有少数标准可以提供任何指导。关于如何实现HATEOAS 没有一个正确的答案,但它可能看起来像:

Bar v1.1

{
  "field_one": "String",
  "field_two": "String",
  "links": [
    { "name": "Foo", "href": "http://localhost/foo/123" }
  ]
}

这使得Bar可以链接到Foo,而不必依赖它。这与使用指向相关页面的超链接组成网站的方式相同。

这是在实施HATEOAS时应该考虑的一些注意事项:

  • 根据统一接口约束,URL是标识符(而不是123人类可能推断的)
  • 应该使用绝对链接URL,因为相关资源可能不在同一主机上,客户端不应该弄清楚。
  • 虽然常见,但URL段的版本控制会导致问题,因为服务器如何知道如何使用适当的API版本生成链接?其他方法(如媒体类型,查询字符串或甚至标题)也不会受此影响。最终,客户负责了解要求的API版本。服务器无法知道客户想要什么。除非服务器保证版本对称,否则很可能客户端将被绑定到不一致的API版本(例如:Foo 1.0和Bar 1.1)。如果所有API必须具有相同的受支持版本,即使没有更改,强制版本对称也可能很难或很慢。我也看过网址模板 用于解决URL段问题,但是 - 再次 - 客户端不应该知道或理解模板语法。

这可以作为您设计的起点。

热门问答

在serverless中,我能否自己host 一个express(nodejs)的服务?

Tina

腾讯云 · 产品经理 (已认证)

Go Serverless!
推荐
您好,可以这样的。您可以参考如下文档,申请下http function 您可以使用常见的 WEB 框架(如 Nodejs Web 框架:Express、Koa)编写 HTTP 函数。而 WEB 框架内置的一些中间件(如cors)也会极大的方便您的业务编写 文档链接 https:...... 展开详请

使用有过期时间的签名往Cos存储桶中上传文件,若上传还在进行中签名过期,上传是否会终止?

galenye

腾讯 · 工程师 (已认证)

对象存储专业搬砖工
推荐已采纳

如果你是使用的简单上传,它能接收5g以内的文件,那签名过期的文件还在上传的话,是没影响的,因为签名判断是在cos接受到请求时。

如果你是使用的sdk等封装的分片上传,那其实是多个请求去上传文件,如果签名过期了,那上传到某一刻,后面的请求都会返回403

存储桶的默认加速域名 cdn 如何更改业务类型, 即把静态加速改成下载加速?

Jinqn

腾讯 · 高级工程师 (已认证)

腾讯云COS前端开发
推荐

我理解你意思是,浏览器打开的时候要下载,不要直接显示。

通过存储桶的文件 Content-Type 来控制

为何我使用.Net API 生成的临时密钥无法进行文件操作?

推荐
cos有自己的密钥系统,应该是在控制台上,访问管理,API密钥,项目密钥那里,或者去看看cos的文档是如何说明的吧。 你通过ms接口创建cos临时密钥,也许的确会被限制一些,这个需要ms这个产品的人回答下比较好。 生成临时密钥和哪个SDK无关,可以直接在线调用也可以生成,通过AP...... 展开详请

tencentcloud-sdk-php-master github代码上没有vendor文件夹?

推荐
因为和composer冲突,因此导出时没有包含vendor目录。如果需要,可以考虑git clone方式拿到,或者到https://cloud.tencent.com/document/sdk/PHP#.E9.80.9A.E8.BF.87.E6.BA.90.E7.A0.81.E5...... 展开详请

织云安装包在哪里下载?

使用织云,必须要满足1、2步骤1、机器要同步到c.isd.com系统。简单讲,就是在c.isd.com上有这台机器(如果c.isd.com没有,而公司的cmdb【cmdb.oa.com】有,则需要同步到c.isd.com即可,同步需要联系zhiyunhelper同步,而没有的话,...... 展开详请

所属标签

扫码关注云+社区

领取腾讯云代金券