无法在Swagger中使用REST注释

时间:2012-09-10 11:11:23

标签: rest swagger api-doc

我已经下载了swagger ui并在本地进行了实验。它在“路径”,“正文”和“查询”等场景中工作正常。但我的大部分用例都使用了休息评论。

即/ resourcePath /;标签 用于检索特定资源的标记的URI。

当我尝试这个时,UI在添加半冒号时会混乱并且排序后的UI格式不正确,并且不能超出此范围。

这是一个已知的限制吗?是否有解决方法来实现此目标? 感谢对此的任何输入..

1 个答案:

答案 0 :(得分:1)

Swagger希望您在path等花括号中指定{tags}参数,并以逗号分隔查询参数,例如id=1,2,3,4。有些框架使用分号作为分隔符,但招摇的是喜欢逗号。

您能用一个更具体的例子来描述您想要做的更多事情吗?根据设计,对api的评论属于descriptionnotes字段以进行操作,有关详细信息,请参阅swagger-core wiki

Swagger codegen项目有一个验证程序,可用于验证您的规范是否格式正确。