在swagger API中指定字符串数组作为主体参数

Question

我想发布一个字符串数组，如

[
  "id1",
  "id2"
]

到基于 Swagger 的 API。在我的大摇大摆的文件中，我有这些行：

paths:
  /some_url:
    post:
      parameters:
        - name: ids
          in: body
          required: true

将< code > id 的类型指定为字符串数组的正确方法是什么？

更新：

根据规范，以下应该在我的选项中工作：

  parameters:
    - in: body
      description: xxx
      required: true
      schema:
        type: array
        items:
          type: string

https://github.com/Yelp/swagger_spec_validator不接受它，并返回一长串错综复杂的错误，这些错误看起来像代码需要一些$ref。

Answer 1

这些答案对我来说都不管用。正如以下Baeldung文章所述：

为了更好地记录API并指导用户，我们可以使用如何插入值的示例标签

因此，完整的工作示例如下：

swagger: "2.0"

info:
  title: A dummy title
  version: 1.0.0

paths:
  /path:
    post:
      parameters:
        - in: body
          description: xxx
          required: true
          name: a name
          schema:
            type: array
            items:
              type: string
            example: ["str1", "str2", "str3"]
      responses:
        default:
          description: OK

您可以在Swagger编辑器中查看示例值现在是如何更好地显示的。

Answer 2

我创造了一个大摇大摆的问题，因为阿诺德提供的帮助，虽然是有效的yaml，但会给你NPE例外时，试图生成。您需要提供如下所示的对象:

  myDataItem:
    type: object
    description: A list of values
    required:
      - values
    properties:
      values:
        type: array
        items:
            type: string

然后参考它（在你的帖子等中）：

  schema:
    $ref: "#/definitions/myDataItem"

供参考的github问题:

https://github.com/swagger-api/swagger-codegen/issues/6745

请注意，该问题已在2.3.0及更高版本中修复，理想情况下您应该升级到该版本。

Answer 3

您对字符串数组的描述是正确的，但是参数定义缺少有效的< code>name属性。

下面是一个完整的工作示例：

swagger: "2.0"

info:
  title: A dummy title
  version: 1.0.0

paths:
  /path:
    post:
      parameters:
        - in: body
          description: xxx
          required: true
          name: a name
          schema:
            type: array
            items:
              type: string
      responses:
        default:
          description: OK

尝试使用在线编辑器来检查您的OpenAPI（fka。招摇）规格：http://editor.swagger.io/