Shulou(Shulou.com)06/01 Report--

This article mainly introduces "how to use the minimum WEB API to achieve file upload" related knowledge, the editor through the actual case to show you the operation process, the method of operation is simple and fast, practical, I hope that this "how to use the minimum WEB API to achieve file upload" article can help you solve the problem.

Foreword:

We use the minimum WEB API to implement the file upload function, although client access is normal, but when we open the Swagger page, we find that it looks like this:

It is not possible to test using Swagger pages.

First, allow Content Type

A normal Swagger page should look like this:

It seems that we need to specify Content Type:

App.MapPost ("/ upload", async (HttpRequest request) = > {var form = await request.ReadFormAsync (); return Results.Ok (form.Files.First () .filename);}) .Accepts ("multipart/form-data")

As a result, the Swagger page looks like this, with a bunch of Form-related attributes added, except for file:

It seems that there is only a custom Swagger page.

II. Custom OperationFilter

In OpenAPI 3.0, requests for file uploads can be described in the following structure:

In Swashbuckle, you can use the IOperationFilter interface to implement action filters that control how the behavior of the Swagger UI is defined.

Here, we will use the RequestBody object to implement the above request structure for file upload.

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 {{FileUploadContentType New OpenApiMediaType {Schema = new OpenApiSchema {Type = "object", Required = new HashSet {"file"} Properties = new Dictionary {{"file" New OpenApiSchema () {Type = "string" Format = "binary"}} } }}}

Then, configure it in the startup code to apply this action filter:

Builder.Services.AddSwaggerGen (setup = > {setup.OperationFilter ();})

This will render the following Swagger page:

This is the end of the content about "how to use the minimum WEB API to upload files". Thank you for reading. If you want to know more about the industry, you can follow the industry information channel. The editor will update different knowledge points for you every day.

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.