设计一个 api - 相互依赖的参数

Question

我正在尝试设计一个rest api。

一些参数是相互依赖的。

所以当有人进行 /account api 调用时，我会返回以下结构

"money": {
     "name": "alpha",
     "data": {
         "total": 30"
     }

}

问题是进入“数据”对象的内容取决于“名称”。

所以如果name = alpha，你会得到下面的json

"money": {
     "name": "alpha",
     "data": {
         "total": 30"
     }

}

如果 name = bravo，您会从我们这里得到以下 json

"money": {
     "name": "bravo",
     "data": {
         "threshold": 30"
     }

}

每个月，帐户的“名称”参数都会更改。上个月它是“alpha”，因为该帐户处于“alpha”计划中。这个月是“bravo”，因为该帐户在“bravo”计划中。

你如何正确设计一个在rest中具有相互依赖的结果参数的api？

Answer 1

在您的 API 文档中，您只是提到格式如下：

"money": {
     "name": "alpha",
     "data": {
         "total": 30,
         "threshold": 30
     }
}

total 和 threshold 是可选的，如果 name == "alpha" 则存在 total，如果 name == "bravo" 则存在 threshold。