Swashbuckle.AspNetCore 5.0.0-rc4 上传文件过滤器不工作

Question

我需要为 Swashbuckle.AspNetCore 5.0.0-rc4 添加上传文件。在早期版本中，它的工作方式如下：

public class SwaggerUploadFileParametersFilter : IOperationFilter
{
    public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
    {
        if (operation.parameters != null)
        {
            var attribute =
                apiDescription.ActionDescriptor.GetCustomAttributes<UploadFileParametersAttribute>()
                    .FirstOrDefault();
            if (attribute != null)
            {
                operation.consumes.Add("multipart/form-data");
                operation.parameters.Add(new Parameter
                {
                    name = "file",
                    required = true,
                    type = "file",
                    @in = "formData"
                }
                );
            }
        }
    }
}

[UploadFileParameters]
public async Task<IHttpActionResult> MyMethod([FromUri]MyMethodParams parameters)

我尝试使用 Microsoft.OpenApi.Models 个对象来实现它：

   public class SwaggerUploadFileParametersFilter : IOperationFilter
    {
        public void Apply(OpenApiOperation operation, OperationFilterContext context)
        {
            var actionAttributes = context.MethodInfo.GetCustomAttributes<UploadFileParametersAttribute>().FirstOrDefault();
            if (actionAttributes != null)
            {
                operation.RequestBody = new OpenApiRequestBody()
                {
                    Content =
                    {
                        ["multipart/form-data"] = new OpenApiMediaType()
                        {
                            Schema = new OpenApiSchema()
                            {
                                Properties =
                                {
                                    ["file"] = new OpenApiSchema()
                                    {
                                        Description = "Select file",
                                        Type = "file"
                                    }
                                }
                            }
                        }
                    }
                };
            }
        }
    }

但是没用。我在 swagger

中没有看到文件组件

Answer 1

我从 Swagger File Upload

中获取了您的代码和一些文档

我修改了您的代码并添加了一些小修复程序

public class SwaggerUploadFileParametersFilter : IOperationFilter
{
    public void Apply(OpenApiOperation operation, OperationFilterContext context)
    {
        var parameters = operation.Parameters;
        if (parameters == null || parameters.Count == 0)
        {
            return;
        }
        var isUploadFile = context.ApiDescription.ActionDescriptor.Parameters.Any(x => x.ParameterType == typeof(IFormFile));

        if (isUploadFile)
        {
            operation.RequestBody = new OpenApiRequestBody()
            {
                Content =
                {
                    ["multipart/form-data"] = new OpenApiMediaType()
                    {
                        Schema = new OpenApiSchema()
                        {
                            Type = "object",
                            Properties =
                            {
                                ["file"] = new OpenApiSchema()
                                {
                                    Description = "Select file", Type = "string", Format = "binary"
                                }
                            }
                        }
                    }
                }
            };
        }
    }
}

和控制器：

[HttpPost]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesDefaultResponseType]
public async Task<IActionResult> UploadFileAsync([FromForm] IFormFile file)

Swashbuckle.AspNetCore 5.0.0-rc4 上传文件过滤器不工作

Swashbuckle.AspNetCore 5.0.0-rc4 UploadFileFilter doesn't work

swagger

swashbuckle

asp.net-core