Question

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

例如，我们有一条付款途径，该途径具有 payment_type 属性，该属性可以保存诸如 paypal ， credit_card strong>，加密等，并且根据该字段，我们需要填写以下类似的属性。

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

是否可以以某种方式标记它们，以便对它们进行分组，例如 crypto cryptocurrency 和 wallet_address 应该设置，而对于 银行转帐 快捷， iban ，帐户名和<应该设置strong> bank_name 。

Answer 1

不，没有这样的选择。受OpenAPI-Specification的限制，请阅读“参数对象”部分以查看可用字段的列表。

现在知道限制并不会消失，下面是一些选择：

您确实拥有description，这是添加您的详细信息的好地方。
您也可以使用Specification Extension，但是默认情况下swagger-ui不会支持该功能，如果您需要UI对扩展进行操作，则需要编码。
@Helen的注释中指出的另一个选项正在使用discriminator，但swagger-ui当前不支持该选项：
https://github.com/swagger-api/swagger-ui/issues/2438

Swagger UI标记参数作为组

1 个答案: