我正在为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” . “高级”将显示具有高级控件的UI,“默认”将显示具有简单控件的UI .
在上面的示例中,它具有值“advanced”作为默认值 . 我不希望有任何默认值,因为我希望调用者显式提供“mode”查询参数的值 . 如果是这种情况,那么URL值在API响应中应如何显示 .
以下是选项
在第二种情况下,调用者必须用“高级”或“默认”替换$ modevalue $
请告诉我在API响应中表示网址的最佳方式是什么?或者还有其他方法吗?