使用最小 WEB API 實現文件上傳的Swagger支持

Posted on by

前言：

上回，我們使用最小 WEB API 實現文件上傳功能《​ ​使用最小 WEB API 實現文件上傳會遇到的坑​​》，雖然客戶端訪問是正常的，但是當打開 Swagger 頁面時，發現是這樣的：

沒法使用 Swagger 頁面測試。

一、允許 Content Type

正常的 Swagger 頁面應該是這樣的：

看來，我們需要指定 Content Type：

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

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

結果，Swagger 頁面變成瞭這樣，增加瞭一堆 Form 相關屬性，唯獨沒有 ​​file​​ :

看來，隻有自定義 Swagger 頁面瞭。

二、自定義 OperationFilter

在 OpenAPI 3.0 中，文件上傳的請求可以用下列結構描述（https://swagger.io/docs/specification/describing-request-body/file-upload/）：

而在 Swashbuckle 中，可以使用 IOperationFilter 接口實現操作篩選器，控制如何定義 Swagger UI 的行為。

在這裡，我們將利用 ​​RequestBody​​ 對象來實現上述的文件上傳的請求結構。

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"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            };
        }
    }
}

然後，在啟動代碼中配置，應用此操作篩選器：

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

這將呈現如下 Swagger 頁面：

到此這篇關於使用最小 WEB API 實現文件上傳的Swagger支持的文章就介紹到這瞭,更多相關使用最小 WEB API 實現文件上傳 內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：