swagger返回枚举_如何在swagger.io中定义枚举?(How to define enum in swagger.io)

问 题

是否有人能够在swaggger 2.0版的"模型"选项卡中定义可能的"枚举"值?示例: http://petstore.swagger.wordnik.com/#!/pet/ addpet 具有"status"属性的枚举选项,但该示例使用的是swagger 1.0版(根据json对象中定义的swagger版本)。我试图在版本2.0中实现相同但没有运气,不确定文档是否正确。

有关于此的任何提示吗?

解决方案

"enum"就像这样:

{

"in":"query",

"name":"sample",

"description":"具有枚举值的示例参数",

"type":"string",

"enum":["1","2"],

"required":true

}

如您所见,有一个名为 sample 的查询参数类型为string ,并有一个枚举说明两个可能的值。在这种情况下,示例声明参数是必需的,因此ui不会显示空值作为选项。

对于最小工作样本,请尝试:

{

"swagger":"2.0",

"info":{

" title":"title",

"description":"descriptor",

"version":"0.1"

},

"paths":{

" / sample":{

"post":{

"description":"sample",

"parameters":[

{

"in":"query ",

"name":"sample",

"description":"带有枚举值的示例参数",

"type":"string",

"enum ":[

"1",

"2"

],

"必需":true

}

],

"回复":{

"200":{

"description":"成功请求。"

}

}

}

}

}

}

要在本地测试它,您可以在javascript中声明一个变量(例如 spec ),并将其传递给swaggerui对象。 / p>var spec = {...};

window.swaggerui = new swaggerui({

url:url,

spec:spec,

dom_id:"swagger-ui-container",

supportedsubmitmethods:['get','post','put','delete'],

oncomplete:function(swaggerapi,swaggerui){

...

在这种情况下, url 参数将被忽略。

最终,输出如下所示:

我能够这样做,但是你可以在下面的图片上看到每个参数创建了下拉列表:

我想要实现的是很好的模型/模型模式选项卡,如下图所示,并为参数列出了可用的枚举。这是否可以在最新版本的swagger中使用:

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值