当前位置: 首页 > 知识库问答 >
问题:

如何在swagger中描述Data Type Array[]的参数

李谦
2023-03-14

如何在swagger UI中将数组对象传递给参数?这是一个GET请求。我有一个数据类型为Array[]和参数类型为query的请求参数。我已经尝试了下面的阵列,它似乎不工作。我不熟悉招摇的用法。无法解决问题。

["dataType": 1,"value": "test","orderid": 1]
[1,1 , 1, 1]
[{1,1 , 1, 1}]
[{"dataType": 1,"value": "test","orderid": 1}]
[ dataType: 1]

型:

public class ItemModel
{
    public int DataType { get; set; }
    public string Value { get; set; }
    public int OrderId { get; set; }
}

共有1个答案

麻烨
2023-03-14

这里您要做的是在< code>components部分(< code>schema子部分)中包含对象定义,然后使用< code>$ref关键字链接到< code>items:下的模式。

这是我使用您描述的参数制定的快速示例:

示例:

架构:

components:
  schemas:
    itemModel:
      properties:
        dataType:
          type: integer
        value:
          type: string
        orderType:
          type: integer
    requestParam:
      properties:
        orders:
          type: array
          items:
            $ref: '#/components/schemas/requestParam'

定义:

    paths:
  /pets:
    post:
      summary: Add a new pet

      requestBody:
        description: Optional description in *Markdown*
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/requestParam'

另一个例子(项目符号 3)http://blog.restcase.com/6-most-significant-changes-in-oas-3-0/

 类似资料:
  • 我通过compojure-api使用ring-swagger。我有几个查询参数,我正在努力寻找一种方法来向单个查询参数添加描述。我可以添加整个endpoint的摘要,但这还不够。 是否可以使用ing-swagger/compojure-api向单个查询参数添加swagger描述?

  • 我正试图弄清楚如何在OpenAPI中记录我的两个查询参数。 null 键是一个关联数组,可以包含API中的资源名称集合列表。分配给每个筛选项的值是单个id或逗号分隔的id列表。 排序 For排序也遵循JSON:API建议,因此如下所示: null 例如,我不确定是否可以指定过滤器键是一个关联数组,或者它接受逗号分隔的ID列表。对于排序几乎同样的问题:如何表示逗号分隔的排序字段列表?

  • 我正试图提供格式化的描述给一个在大摇大摆的控制器。但是,我找不到任何可以启用它的注释。当前看起来如下所示: 然而,我想提供有意义的描述。不推荐使用带有的参数。

  • 我试图用Swagger来描述我正在构建的web-api。问题是我无法理解如何描述复杂的json对象? 比如如何描述这个对象:

  • 我想格式化我的Swagger API描述,使它们不是简单的文本段落。最好是,我想在其中添加一个小表格。 我没有在Swagger描述中找到有关文本格式的在线参考。如果我启动Swagger编辑器,并打开Instagram示例(File \ Open Example \ Instagram.yaml),我看到yaml文件中的第一个描述显示了一些格式,包括超链接和边界框: 这看起来像标准的Markdown

  • 我正在尝试为rest api定义一个简单的swagger定义。我在所有参数部分都收到错误。 我在招摇编辑器中得到了以下招摇定义错误,我不知道我错了什么。请告知。 昂首阔步的定义: 昂首阔步错误: