【问题标题】:Does Apiary.io and/or API Blueprint support api versioning?Apiary.io 和/或 API 蓝图是否支持 api 版本控制?
【发布时间】:2015-09-06 02:22:46
【问题描述】:

api blueprint 或 Apiary.io 是否支持对 API 进行版本控制的概念?特别是,我通过这样的 URI 对我的 API 进行版本控制:

GET /api/v2/SomeResource/

在上面的示例中,这意味着我正在调用 API 的版本 2(“v2”)。 api 蓝图是否支持这个?如何记录给定操作或整个 API 的多个版本?

【问题讨论】:

标签: rest apiblueprint apiary


【解决方案1】:

您可以使用HOST 标头来表示:

HOST: http://example.com/api/v2 将在 all 资源前加上 /api/v2

在 API 蓝图中,如果您使用 URL 前缀,则 API 被认为是不同的,因此您应该为它们使用不同的蓝图。

如果您使用带有版本后缀的媒体类型来执行此操作,您只需在标头中指定正确的Content-Type,它们将正确用于模拟服务器中的内容协商。

【讨论】:

  • 好的,所以目前 Apiary 中并没有对 URL 版本控制有任何特殊支持。很公平。
  • @jakejgordon “特别支持”会是什么样子?
  • 不确定——也许能够通过 UI 启动 API 的新版本,选择新版本号,然后仅将添加新/更改操作添加到较新的蓝图。怀疑这只能由 API 蓝图文件驱动——可能需要 Apiary 中的额外元数据。
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2016-05-06
  • 2011-12-06
  • 2019-07-08
  • 2019-07-23
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多