Swashbuckle.AspNetCore 中如何为二进制文件上传生成正确的 Swagger 文档

在 Web API 开发中，处理二进制文件上传是一个常见需求。当使用 Swashbuckle.AspNetCore 为 ASP.NET Core 应用生成 Swagger/OpenAPI 文档时，对于无参数的文件上传端点，如何正确生成文档可能会让开发者感到困惑。本文将详细介绍解决方案。

问题背景

在 ASP.NET Core 中，处理二进制文件上传通常会使用无参数的方法，直接从请求体中读取数据流。例如：

[HttpPost]
[Route("attachments/upload")]
[Consumes(typeof(Stream), MediaTypeNames.Application.Octet)]
public async Task<ActionResult<UploadAttachmentResult>> UploadAttachment()
{
    using var stream = new MemoryStream();
    await Request.Body.CopyToAsync(stream);
    // 处理文件逻辑
}

然而，这样的方法在默认情况下生成的 Swagger 文档不会包含正确的请求体定义，导致客户端生成工具无法正确理解这是一个文件上传端点。

解决方案

要为这种无参数的文件上传端点生成正确的 Swagger 文档，我们需要使用自定义的 Operation Filter。以下是具体实现步骤：

1. 创建自定义 Operation Filter

public class BinaryRequestBodyOperationFilter : IOperationFilter
{
    public void Apply(OpenApiOperation operation, OperationFilterContext context)
    {
        if (operation.RequestBody == null)
        {
            operation.RequestBody = new OpenApiRequestBody();
        }

        operation.RequestBody.Content["application/octet-stream"] = new OpenApiMediaType
        {
            Schema = new OpenApiSchema
            {
                Type = "string",
                Format = "binary"
            }
        };

        operation.RequestBody.Required = true;
    }
}

这个过滤器会为操作添加一个符合 OpenAPI 规范的请求体定义，指定内容类型为 application/octet-stream，并将数据类型标记为二进制格式。

2. 应用到控制器方法

在控制器方法上应用这个过滤器：

[HttpPost]
[Route("attachments/upload")]
[Consumes(typeof(Stream), MediaTypeNames.Application.Octet)]
[SwaggerOperationFilter(typeof(BinaryRequestBodyOperationFilter))]
public async Task<ActionResult<UploadAttachmentResult>> UploadAttachment()
{
    // 方法实现
}

3. 生成的 Swagger 文档效果

应用过滤器后，生成的 Swagger 文档将包含正确的请求体定义：

"requestBody": {
    "content": {
        "application/octet-stream": {
            "schema": {
                "type": "string",
                "format": "binary"
            }
        }
    },
    "required": true
}

技术原理

1. OpenAPI 规范：OpenAPI 规范使用 type: string 和 format: binary 的组合来表示二进制数据。

2. Operation Filter：Swashbuckle.AspNetCore 提供了 IOperationFilter 接口，允许开发者在生成文档时自定义操作的定义。

3. 内容类型协商：[Consumes] 属性确保 API 只接受指定的内容类型，而 Operation Filter 则确保文档正确反映这一要求。

进阶用法

如果需要支持多种内容类型，可以扩展过滤器：

operation.RequestBody.Content["application/octet-stream"] = new OpenApiMediaType
{
    Schema = new OpenApiSchema { Type = "string", Format = "binary" }
};

operation.RequestBody.Content["multipart/form-data"] = new OpenApiMediaType
{
    Schema = new OpenApiSchema
    {
        Type = "object",
        Properties = new Dictionary<string, OpenApiSchema>
        {
            ["file"] = new OpenApiSchema { Type = "string", Format = "binary" }
        }
    }
};

总结

通过自定义 Operation Filter，我们可以为无参数的文件上传端点生成准确的 Swagger 文档。这种方法不仅解决了文档生成问题，还能确保生成的客户端代码能够正确处理二进制文件上传。对于需要处理文件上传的 Web API 项目，这是一个值得掌握的技巧。