Can Swagger可以在Microsoft Web API的querystring中描述一系列复杂类型

时间:2016-06-09 11:42:25

标签: asp.net asp.net-web-api2 swagger

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

例如,传递一个GeoPoint(Lat / Lon)对象数组,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]部分。

1 个答案:

答案 0 :(得分:1)

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