Swashbuckle.AspNetCore 中 FromForm 参数在 OpenAPI 文档生成的问题解析

问题背景

在 Swashbuckle.AspNetCore 6.8.1 版本中，开发者在使用 Minimal API 时发现了一个关于 [FromForm] 参数在 OpenAPI 文档生成中的问题。当 API 端点同时接收表单文件和表单字段时，生成的 OpenAPI 文档结构不正确，导致 Swagger UI 无法正确显示表单字段的输入框。

问题现象

考虑以下 Minimal API 端点定义：

app.MapPost(
    "{tool}/{scenario}/{fileName}",
    async (
        string tool,
        string scenario,
        string fileName,
        [FromForm(Name = "tags")] string tags,
        IFormFile file,
        HttpRequest request) =>
    {
        return Results.Ok();
    })
.WithName("Upload")
.DisableAntiforgery()
.WithOpenApi();

开发者期望生成的 OpenAPI 文档应该将 tags 和 file 都作为表单的属性显示，但实际上生成的文档结构存在问题。

预期与实际行为对比

预期行为

正确的 OpenAPI 文档应该将 tags 和 file 都作为表单属性：

"requestBody": {
    "content": {
        "multipart/form-data": {
            "schema": {
                "required": ["file"],
                "type": "object",
                "properties": {
                    "file": {
                        "type": "string",
                        "format": "binary"
                    },
                    "tags": {
                        "type": "string"
                    }
                }
            }
        }
    }
}

实际行为

实际生成的文档中，tags 被错误地处理为一个独立的字符串类型，并与文件参数合并为 allOf 结构：

"requestBody": {
    "content": {
        "multipart/form-data": {
            "schema": {
                "allOf": [
                    {
                        "type": "string"
                    },
                    {
                        "required": ["file"],
                        "type": "object",
                        "properties": {
                            "file": {
                                "type": "string",
                                "format": "binary"
                            }
                        }
                    }
                ]
            }
        }
    }
}

这种结构表示请求体既是字符串又是包含文件的对象，这显然不符合实际 API 的行为。

技术分析

这个问题源于 Swashbuckle.AspNetCore 对 [FromForm] 参数的处理逻辑。在之前的版本中，开发者需要手动修改生成的 schema 来正确显示表单字段。虽然新版本声称改进了对 [FromForm] 的支持，但在处理同时包含表单字段和文件上传的场景时仍存在问题。

从技术实现上看，问题出在参数到 OpenAPI schema 的转换过程中：

1. IFormFile 参数被正确识别为文件上传类型
2. [FromForm] 标记的字符串参数被单独处理为字符串类型
3. 系统错误地将这两种不同类型的参数合并为 allOf 结构，而不是将它们作为同一对象的属性

解决方案

根据项目维护者的反馈，这个问题已经在内部修复。修复后的版本会正确处理这种情况，将表单字段和文件参数作为同一对象的属性：

"schema": {
    "allOf": [
        {
            "type": "object",
            "properties": {
                "tags": {
                    "type": "string"
                }
            }
        },
        {
            "required": ["file"],
            "type": "object",
            "properties": {
                "file": {
                    "type": "string",
                    "format": "binary"
                }
            }
        }
    ]
}

虽然仍然使用了 allOf 结构，但这种表示方式在技术上是正确的，因为：

1. 它明确表示了这是一个对象
2. 将不同来源的属性组合在一起
3. 保持了 OpenAPI 规范的一致性

最佳实践建议

对于需要在 Minimal API 中处理表单数据和文件上传的场景，开发者可以考虑以下建议：

1. 使用 DTO 对象：将表单参数封装到一个专门的 DTO 类中，可以避免这种参数解析问题

   public class UploadRequest
   {
       public string Tags { get; set; }
       public IFormFile File { get; set; }
   }
   

2. 等待修复版本发布：如果坚持使用参数列表形式，可以等待包含此修复的 Swashbuckle.AspNetCore 新版本发布

3. 手动修改文档：在修复版本发布前，可以使用文档过滤器手动修正生成的 OpenAPI 文档

总结

Swashbuckle.AspNetCore 在处理 [FromForm] 参数与文件上传结合的场景时存在文档生成问题，这会影响 API 文档的准确性和可用性。虽然使用 allOf 结构在技术上是有效的，但开发者更期望看到简洁直观的表单属性表示。项目团队已经意识到这个问题并提供了修复方案，开发者可以根据自身需求选择临时解决方案或等待官方修复。