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) 这种行为不是 spec 的一部分.

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

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