RAML:在资源中引用uriParameters

时间:2014-04-09 18:26:52

标签: api mime-types raml

我在RAML中编写API规范,并想知道是否可以引用uri参数来创建动态mime类型。

的内容
baseUri: http://api.mycompany.com/{version}

/first_resource:
  get:
    responses:
      200:
        body:
          application/custom.mime.type.{version}+json

1 个答案:

答案 0 :(得分:2)

目前(v 0.8)此类行为不属于spec

您在示例代码中所看到的内容可能会为开发人员添加错误路径 - 您的服务器实现必须满足:如果在http://api.mycompany.com/v1处创建某个资源请求会发生什么,但是由于某些原因包含Content-Type: custom.mime.type.v2+json - 标题?

当使用自定义版本化MIME类型时,我的建议是使用非版本化的URL来避免设计中的这种情况。对于无法发送所需标题的客户,您仍然可以使用查询字符串或者有什么来提供回退...