如何在HTTP GET响应正文中的URL中的查询字符串中返回占位符

时间:2018-12-09 16:24:51

标签: rest http api-design

我正在建模REST API,如下所示。

获取API /元数据

API将返回元数据信息列表以及Web应用程序的URL。 API调用程序将查找该URL,然后使用该URL调用Web应用程序。在进行该HTTP调用之前,它还必须提供查询参数的值。

以下是示例回复

{
  "item1" : "value 1"
  "item2" : "value 2"
  "url"   " "http://myserver.com/page?id=10&mode=advanced"
}

查询参数“ mode”可以有2个值,“ advanced”或“ default”。 “高级”将显示带有高级控件的用户界面,“默认”将显示带有简单控件的用户界面。

在上面的示例中,其值为“ advanced”(默认)。我不想具有任何默认值,因为我希望调用方为“ mode”查询参数显式提供一个值。在这种情况下,URL值在API响应中应如何显示。

这是选项

  1. http://myserver.com/page?id=10&mode=
  2. http://myserver.com/page?id=10&mode= $ modevalue $

在第二种情况下,调用者必须将$ modevalue $替换为“高级”或“默认”

请让我知道在API响应中表示URL的最佳方法是什么?还是还有其他方法?

0 个答案:

没有答案