Swagger - 定义多部分文件请求的最大大小限制

Posted 2023-02-19

【中文标题】Swagger - 定义多部分文件请求的最大大小限制

【英文标题】：Swagger - Define Max Size Limit for Multipart File Requests

【发布时间】：2021-10-18 13:44:05

【问题描述】：

我有一个使用 Spring 创建的 API，我使用 swagger.yaml 文件（我使用 openapi 3.0.1）来定义资源。

在我的application.yaml 中，我定义了多部分请求的限制，例如：

spring.servlet.multipart.max-file-size：15MB spring.servlet.multipart.max-request-size：30MB

我的问题是，我可以将这些相同的限制信息定义为 swagger 吗？在我研究的过程中，我看到了maxLength 和minLength，但我猜这些是针对字符串限制的

【参考方案1】：

可以，看看https://docs.swagger.io/swagger-core/v2.0.0-RC3/apidocs/io/swagger/v3/oas/annotations/media/Schema.html

还有https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schemaObject

允许您在 OpenApi 3.X.X 中指定模式的长度

如果您使用的是 Spring Boot，只需添加 @Schema(minLength = YOUR_MIN, maxLength = YOUR_MAX) 到你的班级 这可以应用于请求正文类， 如果您想定义特定的字段长度，您可以使用 jakarta.validation-api 通过 @Size(min= YOUR_MIN, max= YOUR_MAX) 注释属性