如何在 swagger 表单数据字段中传递字符串数组

Question

我想在表单数据中传递一个数组，如下所示：

但我在 NodeJS 控制台中将整个数组作为字符串获取，如下所示：

{
  targetUniversity: "['613e3ecfefa725074cb17968', '613e3ecfefa725074cb17969']",
  targetBusinessType: "['freelancer','sw dev']",
}

swagger 文件看起来像这样，

"/announce": {
      "post": {
        "tags": ["Announcement"],
        "description": "Make an announcement",
        "parameters": [
          {
            "name": "targetUniversity",
            "in": "formData",
            "type": "array",
            "description": "University ID in array []- from DD"
          },
          {
            "name": "targetBusinessType",
            "in": "formData",
            "type": "array",
            "description": "Business type (string - name) in array []"
          }
        ],
        "produces": ["application/json"],
        "responses": {
          "201": {
            "description": "announced successfully"
          }
        }
      }
    }

我只想要数组本身，而不是字符串格式的数组。

Answer 1

数组参数需要items关键字来定义数组项的类型。此外，该操作必须指定它的 MIME 类型consumes:

        "consumes": [
          "application/x-www-form-urlencoded"
        ],
        "parameters": [
          {
            "name": "targetUniversity",
            "in": "formData",
            "type": "array",
            "items": {           // <------
              "type": "string"
            },
            "description": "University ID in array []- from DD"
          },
          {
            "name": "targetBusinessType",
            "in": "formData",
            "type": "array",
            "items": {           // <------
              "type": "string"
            },
            "description": "Business type (string - name) in array []"
          }
        ],

在 Swagger UI 中，每行输入一个数组项，不带引号：

Answer 2

您可以在OAS3中指定数组如下；

"parameters": [
    {
      "name": "targetUniversity",
      "in": "formData", -->> according to comments this should be replaced by requestBody in OAS3
      "schema": {
        "type": "array",
        "items": {
          "type": "string"
        }
    ...

结果会是这样的；