api - RAML：在资源中引用 uriParameters

Question

我正在用 RAML 编写 API 规范，并且想知道是否可以引用 uri 参数来创建动态 mime 类型。类似的东西

baseUri: http://api.mycompany.com/{version}

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

Answer 1

目前（v 0.8）这种行为不是规范的一部分。

您在示例代码中所追求的可能会为开发人员添加一条错误路径 - 您的服务器实现必须满足：如果对某个资源的请求在某处http://api.mycompany.com/v1发出，但由于某些原因包含Content-Type: custom.mime.type.v2+json-Header 会发生什么？

使用自定义版本化 MIME 类型时，我的建议是使用非版本化 URL 来避免这种情况。对于无法发送所需标头的客户，您仍然可以使用查询字符串或what-have-you ...