使用Swashbuckle Swagger上传文件

ber*_*zoo 5 c# swagger asp.net-core

我有一个带有Swagger 3.0的ASP.NET Core 2应用程序,我想测试来自Swagger UI的文件上传的POST操作.

文件上传器控制器:

[ApiController]
public class FileUploadController : ApiControllerBase
{
    private readonly IFileUploader _fileUploader;

    public FileUploadController(IFileUploader fileUploader, ILogger<FileUploadController> logger) : base(logger)
    {
        _fileUploader = fileUploader;
    }

    [HttpPost]
    [Route(nameof(UploadFile))]
    public FileUploadResult UploadFile(IFormFile uploadedFile)
    {
        return _FileUploader.UploadFile(Request.Form.Files[0]);
    }
}
Run Code Online (Sandbox Code Playgroud)

阅读Swagger文档和其他主题我发现我需要自定义IOperationFilter,所以这就是我提出的:

public class FileUploadOperationFilter : IOperationFilter
{
    public void Apply(Operation operation, OperationFilterContext context)
    {
        if (operation.OperationId.ToLower() == "apifileuploaduploadfilepost")
        {
            operation.Parameters.Add(new NonBodyParameter()
            {
                Name = "file",
                In = "formData",
                Description = "Upload File",
                Required = true,
                Type = "file"
            });
            operation.Consumes.Add("multipart/form-data");
        }
    }
}
Run Code Online (Sandbox Code Playgroud)

它在Swagger启动类中注册:

                options.OperationFilter<FileUploadOperationFilter>();
Run Code Online (Sandbox Code Playgroud)

因此,IFormFile中的所有字段都消失了,而且还有上传文件控件,所以我可以选择"试一试"按钮,选择一个文件,但在按下"执行"后我收到以下错误: 在此输入图像描述

web api本身不会崩溃,也不会抛出任何错误.在调试过程中我注意到了 - FileUploadController到达了构造函数但是没有触发FileUpload方法.

ber*_*zoo 0

通过从参数中删除 IFormFile uploadedFile 来解决:

    [HttpPost]
[Route(nameof(UploadFile))]
public FileUploadResult UploadFile()
{
    return _FileUploader.UploadFile(Request.Form.Files[0]);
}
Run Code Online (Sandbox Code Playgroud)