RAML 资源类型和特征 VS Swagger $ref

Posted

技术标签:

【中文标题】RAML 资源类型和特征 VS Swagger $ref【英文标题】:RAML resourceTypes and traits VS Swagger $ref 【发布时间】:2015-03-23 04:29:56 【问题描述】:

我非常喜欢 RAML 如何通过使用 ResourceTypes 和 Traits 专注于减少重复数量并提高 API 之间的一致性。

但是在仔细查看 Swagger 规范之后,您似乎可以通过使用 $ref 来完成同样的事情。

在这种情况下,RAML 是否比 $ref 更有优势?我错过了什么吗?

【问题讨论】:

【参考方案1】:

在我对此进行了更多研究之后,我对它的工作原理有了更好的了解。

一个很大的不同是 RAML 中的 ResourceTypes 接受参数,这样可以提取更多的代码。

此外,您可以在 swagger 中使用 $ref 的地方受到限制。这意味着,您不能在资源级别或 http 方法上应用 $ref。您可以外化的示例包括参数、响应和模型。

ResourceTypes 和 Traits 在外部化 REST 中的常见模式并在不同服务中重用它们方面更强大

【讨论】:

我正在使用特征在 RAML 中定义多个标头规范。我有几个在大量资源中重复使用的标头。现在我正试图从 RAML 切换到招摇。复制内联标题定义对我来说似乎完全是矫枉过正。你知道我是否可以在 swagger 中为标题重用特征?

以上是关于RAML 资源类型和特征 VS Swagger $ref的主要内容,如果未能解决你的问题,请参考以下文章

将 Swagger JSON 转换为 RAML/YAML

RAML 文件的验证

RAML:在资源中引用 uriParameters

RAML 默认信封

在许多文件中拆分 swagger 定义

是从体型(RAML)中排除属性的方法吗?