It's not easy to say I love you | use the minimum web API to upload files (swagger support) ＃ yyds dry inventory ＃

Preface

Last , We use the smallest WEB API Realize file upload function （《​ ​ It's not easy to say love you | Use minimum WEB API File upload ​​》）, Although client access is normal , But when open Swagger When the page is , It turns out that ：

Can't use Swagger Test page .

allow Content Type

natural Swagger The page should look like this ：

It seems , We need to specify Content Type：

Log in and copy

      
      

       
       app.MapPost("/upload",
       
       
    async (HttpRequest request) =>
       
       
    {
       
       
        var form = await request.ReadFormAsync();
       
       

       
       
        return Results.Ok(form.Files.First().FileName);
       
       
    }).Accepts<HttpRequest>("multipart/form-data");
      
      
      
      

       
       
1.
       
       
2.
       
       
3.
       
       
4.
       
       
5.
       
       
6.
       
       
7.
      
      

result ,Swagger The page becomes like this , Added a pile of Form Related properties , Only No ​​file​​ :

It seems , Only custom Swagger Page .

Customize OperationFilter

stay OpenAPI 3.0 in , The request for file upload can be described with the following structure （https://swagger.io/docs/specification/describing-request-body/file-upload/）：

And in the Swashbuckle in , have access to IOperationFilter Interface implements the action filter , Controls how Swagger UI act .

ad locum , We will use ​​RequestBody​​ Object to realize the above file upload request structure .

Log in and copy

      
      

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

       
       
1.
       
       
2.
       
       
3.
       
       
4.
       
       
5.
       
       
6.
       
       
7.
       
       
8.
       
       
9.
       
       
10.
       
       
11.
       
       
12.
       
       
13.
       
       
14.
       
       
15.
       
       
16.
       
       
17.
       
       
18.
       
       
19.
       
       
20.
       
       
21.
       
       
22.
       
       
23.
       
       
24.
       
       
25.
       
       
26.
       
       
27.
       
       
28.
       
       
29.
       
       
30.
       
       
31.
       
       
32.
       
       
33.
       
       
34.
       
       
35.
       
       
36.
       
       
37.
       
       
38.
       
       
39.
       
       
40.
       
       
41.
       
       
42.
       
       
43.
       
       
44.
      
      

then , Configure... In the startup code , Apply this action filter ：

Log in and copy

      
      

       
       builder.Services.AddSwaggerGen(setup =>
       
       
{
       
       
    setup.OperationFilter<FileUploadOperationFilter>();
       
       
});
      
      
      
      

       
       
1.
       
       
2.
       
       
3.
       
       
4.
      
      

This will appear as follows Swagger page ：

Conclusion

today , We use ​​IOperationFilter​​ Solved the minimum WEB API Realize file upload Swagger Support .

Want to know more about , Please pay attention to my official account ”My IO“