Swagger 能否在 Web API 的查询字符串中描述一系列复杂类型Microsoft



我正在尝试为使用Microsoft Web API框架的API添加Swagger文档。

例如,传递 GeoPoint (纬度/纬度) 对象的数组,Web API 要求从查询字符串绑定的复杂类型的数组具有以下格式。

/api/Location?points[0][Lat]=1.2&points[0][Lon]=3.4

这是有效的。

我的问题:是否可以在 Swagger JSON 文档中记录此集合格式和数组类型?

我认为相关规范在这里 http://swagger.io/specification/#parameterObject

对于 type=array 和 collectionFormat=multi,它似乎想重复 'points' 参数,但不知道数组索引 [0] 部分。

不是真的。 首先,swagger 定义中的查询参数是基元值或基元值数组。 接下来,通过替换在查询字符串中分配数组位置不是标准 swagger-ui 的一部分。 你可能可以让它工作,但我怀疑没有其他招摇的工具会知道如何处理它。

最新更新