【问题标题】:Custom query parameter name in RAMLRAML 中的自定义查询参数名称
【发布时间】:2016-07-24 00:22:44
【问题描述】:

我正在尝试使用 RAML 来描述以下 API 调用

PUT /api/v1/kv_store?{key}={value}

这是一个简单的键值存储。我需要指定key 值可以是任何字符串,API 控制台应该让用户可以输入它以及任何其他参数。

真的可行吗?我正在阅读 RAML 1.0 规范,但找不到方法,所以小例子真的很棒。

【问题讨论】:

  • 不确定是否可行,但如果您将 API 更改为 ?key={}&value={value},则很容易指定。
  • 当然,这是一个解决方案,但是更改 API 非常痛苦,不幸的是,“让 RAML 易于描述”并不是一个足够好的理由
  • 知道了,我不确定您是否有重新考虑 API 的余地。

标签: raml


【解决方案1】:

你做错了。 请阅读Documentation

通过以下代码实现QueryParameters 的正确方法。 因为这将满足您的http://api/v1/kv_store/

/songs:
  put:
    queryParameters:
      id: number
      name: string
      type: string
      album: number

【讨论】:

  • 我问过这个问题是因为我需要这样做。我需要一个可变参数名称的可能性,而不是固定的。
猜你喜欢
  • 1970-01-01
  • 2020-11-18
  • 2021-10-27
  • 2012-05-21
  • 1970-01-01
  • 2012-05-28
  • 2018-01-15
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多