更多_想说爱你不容易|使用最小WEBAPI实现文件上传（Swagger支持）

篇首语：本文由编程笔记#小编为大家整理，主要介绍了想说爱你不容易 | 使用最小 WEB API 实现文件上传（Swagger 支持）相关的知识，希望对你有一定的参考价值。

上回&＃xff0c;我们使用最小 WEB API 实现文件上传功能&＃xff08;《想说爱你不容易 | 使用最小 WEB API 实现文件上传》&＃xff09;&＃xff0c;虽然客户端访问是正常的&＃xff0c;但是当打开 Swagger 页面时&＃xff0c;发现是这样的&＃xff1a;

没法使用 Swagger 页面测试。

正常的 Swagger 页面应该是这样的&＃xff1a;

看来&＃xff0c;我们需要指定 Content Type&＃xff1a;

app.MapPost("/upload",
    async (HttpRequest request) &＃61;>
    
        var form &＃61; await request.ReadFormAsync();
        return Results.Ok(form.Files.First().FileName);
    ).Accepts("multipart/form-data");

结果&＃xff0c;Swagger 页面变成了这样&＃xff0c;增加了一堆 Form 相关属性&＃xff0c;唯独没有 file :

看来&＃xff0c;只有自定义 Swagger 页面了。

在 OpenAPI 3.0 中&＃xff0c;文件上传的请求可以用下列结构描述&＃xff08;https://swagger.io/docs/specification/describing-request-body/file-upload/&＃xff09;&＃xff1a;

而在 Swashbuckle 中&＃xff0c;可以使用 IOperationFilter 接口实现操作筛选器&＃xff0c;控制如何定义 Swagger UI 的行为。

在这里&＃xff0c;我们将利用 RequestBody 对象来实现上述的文件上传的请求结构。

public class FileUploadOperationFilter : IOperationFilter
    public void Apply(OpenApiOperation operation, OperationFilterContext context)
    
        const string FileUploadContentType &＃61; "multipart/form-data";
        if (operation.RequestBody &＃61;&＃61; null ||
            !operation.RequestBody.Content.Any(x &＃61;>
            x.Key.Equals(FileUploadContentType, StringComparison.InvariantCultureIgnoreCase)))
        
            return;
         
        
        if (context.ApiDescription.ParameterDescriptions[0].Type &＃61;&＃61; typeof(HttpRequest))
        
            operation.RequestBody &＃61; new OpenApiRequestBody
            
                Description &＃61; "My IO",
                Content &＃61; new Dictionary
                
                    
                        FileUploadContentType, new OpenApiMediaType
                        
                            Schema &＃61; new OpenApiSchema
                            
                                Type &＃61; "object",
                                Required &＃61; new HashSet "file" ,
                                Properties &＃61; new Dictionary
                                
                                    
                                        "file", new OpenApiSchema()
                                        
                                            Type &＃61; "string",
                                            Format &＃61; "binary"
                                        
                                    
                                
                            
                        
                    
                
            ;
        
    


然后&＃xff0c;在启动代码中配置&＃xff0c;应用此操作筛选器&＃xff1a;

builder.Services.AddSwaggerGen(setup &＃61;>
    setup.OperationFilter();
);

这将呈现如下 Swagger 页面&＃xff1a;

今天&＃xff0c;我们使用 IOperationFilter 解决了最小 WEB API 实现文件上传的 Swagger 支持。

想了解更多内容&＃xff0c;请关注我的个人公众号”My IO“