Question

我正在尝试为此multipart/form-data请求创建OpenAPI定义：

curl -X POST \
  http://localhost:1234/api/v1/Submit \
  -H 'cache-control: no-cache' \
  -H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  -H 'sessionkey: kjYgfORsZ0GeiCls0FcR7w==' \
  -F item1=abc \
  -F item2=def
  -F item3=ghi
  ...

我的API定义是这样的：

post:
  consumes:
    - multipart/form-data
  produces:
    - application/json
  parameters:
    - in: formData
      name: item1
      type: string
    - in: formData
      name: item2
      type: string

它适用于formData中的固定字段。

但是，我的表单数据将是动态的，我需要能够发送任意键和值。

我尝试更改表单参数以使用数组和additionalProperties，但它不会产生所需的结果：

- in: formData
  schema:
  additionalProperties:
    type: object

...

- in: formData
  type: array
  items:
    type: string

是否可以使用不同的键和值定义动态formData？

Answer 1

动态表单数据可以使用OpenAPI 3.0定义，但不能使用OpenAPI 2.0（Swagger 2.0）定义。 OpenAPI 2.0仅支持表单数据中的固定密钥名称。

在OpenAPI 3.0中，您可以使用带有additionalProperties：

的架构来描述动态表单数据

openapi: 3.0.1
...
servers:
  - url: 'http://localhost:1234/api/v1'
paths:
  /Submit:
    post:
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              # Object properties correspond to form fields
              type: object
              additionalProperties:
                type: string
      responses:
        '200':
          description: OK

Swagger UI和Swagger Editor用户注意事项：截至撰写本文时（2018年4月），尚不支持OAS3表单数据。您可以跟踪问题#3641和#3781以获取更新。

如何使用OpenAPI（Swagger）描述动态表单数据？

1 个答案: