使用 Swagger CodeGen，如何为上传的文件定义有效的 MIME 类型？

Question

赏金将在 4 小时后到期。 此问题的答案有资格获得+250声望赏金。 Dave正在从可靠的来源寻找答案。

我正在使用 OpenAPI 3.0.1 和 swagger-codegen-maven-plugin 3.0.27（很高兴调整这些版本）。 我已经为上传文件（连同其他数据）定义了以下内容......

  /myobject/:
      post:
        tags:
          - my-objects
        operationId: add
        requestBody:
          content:
            multipart/form-data:
              schema:
                $ref: '#/components/schemas/MyDTO'
          required: true

    ...
  schemas:
    MyDTO:
      type: object
      properties:
    ...
        dataFile:
          type: string
          format: binary

我想将上传的文件类型限制为 mime 类型为“application/vnd.ms-excel”和“text/csv”的文件类型。 我如何使用 OpenAPI 规范/Swagger CodeGen 做到这一点？

Answer 1

您可以在规范中定义encoding部分，定义预期的 mime 类型，例如

...
encoding: # The same level as schema
    dataFile: # Property name
        contentType: application/vnd.ms-excel, text/csv
...

参考https://swagger.io/docs/specification/describing-request-body/multipart-requests/

Answer 2

要限制可以使用 OpenAPI 规范和 Swagger CodeGen 上传的文件类型，您可以使用 requestBody object 中的 consumes 字段来指定允许的 MIME 类型。

下面是一个示例，说明如何使用 consumes 字段来限制可以上传到“application/vnd.ms-excel”和“text/csv”的文件类型：

/myobject/:
  post:
    tags:
      - my-objects
    operationId: add
    requestBody:
      content:
        multipart/form-data:
          schema:
            $ref: '#/components/schemas/MyDTO'
      required: true
      consumes:
        - application/vnd.ms-excel
        - text/csv

components:
  schemas:
    MyDTO:
      type: object
      properties:
        ...
        dataFile:
          type: string
          format: binary

consumes 字段指定 API 将接受作为输入的 MIME 类型。 在这种情况下，只接受 MIME 类型为“application/vnd.ms-excel”或“text/csv”的文件。

Answer 3

我希望这会使无效数据类型的请求失败：

  /myobject/:
      post:
        tags:
          - my-objects
        operationId: add
        requestBody:
          content:
            multipart/form-data:
              schema:
                $ref: '#/components/schemas/MyDTO'
              encoding:
                dataFile:
                  contentType: application/vnd.ms-excel, text/csv
          required: true