RAML：在资源中引用 uriParameters

Posted 2023-02-19

【中文标题】RAML：在资源中引用 uriParameters

【英文标题】：RAML: Referencing uriParameters in resources

【发布时间】：2014-05-23 03:39:30

【问题描述】：

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

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

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

【参考方案1】：

目前 (v 0.8) 这种行为不属于spec。

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

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