我已经下载了 swagger ui 并在本地进行了实验。它在 "path"、"body" 和 "query" 等场景中运行良好。但是我的大多数用例都使用了其余注释。
即 /resourcePath/;tags 用于检索特定资源标签的 URI。
当我尝试这个时,添加分号时 UI 会变得混乱,并且排序的 UI 格式不正确,并且不能超出此范围。
那么这是一个已知的限制吗?有没有办法实现这个目标?感谢对此的任何输入..
Swagger 期望您path
在大括号中指定参数,例如{tags}
,并将参数查询为逗号分隔,例如id=1,2,3,4
. 一些框架使用分号作为分隔符,但 swagger 喜欢逗号。
你能用一个更具体的例子来描述你想要做什么吗?根据设计,对 api 的注释属于操作的description
和notes
字段,请参阅swagger-core wiki了解详细信息。
Swagger codegen项目有一个验证器,可用于验证您的规范是否正确格式化。