当前位置: 首页 > 知识库问答 >
问题:

Swagger UI将参数标记为组

龙欣德
2023-03-14

是否可以以某种方式标记属性,以便在发送请求时可以理解在SwaggerUI中应设置哪个字段。

例如,我们有一个支付路由,它具有payment_type属性,可以保存paypal、credit_card、crypto等值。基于该字段,我们需要填充不同的属性,如下所示。

{
  "payment": 0,
  "paypal": "test@test.com",
  "cryptocurrency": "test",
  "wallet_address": "test",
  "swift": "test",
  "iban": "test",
  "account_name": "test",
  "bank_name": "test"
}

是否有可能以某种方式标记它们,以便将它们分组,例如对于加密加密货币,应该设置wallet_address,而对于银行转帐,应设置快速,iban,account_name和bank_name。

共有1个答案

湛光明
2023-03-14

不,没有这样的选择。我们受到OpenAPI规范的限制,请阅读参数对象部分以查看可用字段的列表。

现在知道了限制并不是失去一切,这里有几个选择:

> < li>

您有< code >描述,这是添加您的详细信息的好地方。

@Helen在评论中指出的另一个选项是使用< code>discriminator,但目前不被swagger-ui支持:< br > https://github.com/swagger-api/swagger-ui/issues/2438

 类似资料:
  • 我一直在切换模板工厂函数来使用(和理解)d::f支持右值和移动语义学。我常用的模板类样板工厂函数总是将参数标记为const: 按预期编译。最初,我将MakeMyPair转换为以const形式传递参数,但这不会使用XCode 4.6在我的Mac上编译: 没有用于调用“MakeMyPair\U Forward”候选函数的匹配函数[具有T=int,U=bool]不可行:没有从“int”到“const i

  • 我使用Restler框架来编写我的API,它使用swagger来记录东西。当我定义我的方法时,我对结果文档有两个问题。一个是参数的描述没有显示在swagger中,另一个是它说它们都是必需的。我如何在文档中将它们标记为可选的?我正在做类似下面的事情,其中类别和图片是可选参数。

  • SwaggerUI 汉化版;修改了部分样式;结合SpringFox SpringFox-Swagger-UI实现API管理

  • 所以基本上我还是个新手,我在javascript中做了一个函数,把一个按钮变成一个选项标记,这样我就可以在0-4之间进行选择。现在我想改变选项,这样我就可以从一个数组中选择,但我不知道怎么做。我尝试将代码中的5改成数组的名称,但没有选项。

  • 命令行参数标记是为命令行程序指定选项参数的常用方法。例如,在命令wc -l中,-l就是一个命令行参数标记。 Go提供了flag包来支持基本的命令行标记解析。我们这里将要使用这个包提供的方法来实现带选项的命令行程序。 package main import "flag" import "fmt" func main() { // 基础的标记声明适用于string,integer和bool型选

  • 我有一个数组,看起来像这样: 它是一个任意长度的数组,带有许多重复字段(为了清楚起见,我将其减少为两个字段)。这被传递到JavaScript方法中。 我想知道你将如何在JSDoc中记录这一点。例如,你将如何记录问号所在的类型?