使用最小 WEB API 实现文件上传的Swagger支持

 更新时间:2022年02月20日 10:22:46   作者:My IO  
这篇文章主要介绍了使用最小 WEB API 实现文件上传Swagger支持,我们使用最小 WEB API 实现文件上传功能,虽然客户端访问是正常的,但是当打开 Swagger 页面时,没法使用 Swagger 页面测试,下面就来一篇支持Swagger的,需要的小伙伴可以参考一下

前言:

上回,我们使用最小 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 实现文件上传 内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • ASP.NET mvc异常处理的方法示例介绍

    ASP.NET mvc异常处理的方法示例介绍

    这篇文章主要介绍了ASP.NET mvc异常处理的方法,需要的朋友可以参考下
    2014-04-04
  • Asp.Net Couchbase Memcached图文安装调用开发

    Asp.Net Couchbase Memcached图文安装调用开发

    本文主要是是如何安装CouchBase服务端,以及客户端如何进行调用。图文详解,大家参考吧
    2013-11-11
  • .NET Core创建一个控制台(Console)程序

    .NET Core创建一个控制台(Console)程序

    这篇文章主要为大家详细介绍了.NET Core如何创建一个控制台程序,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-04-04
  • ASP.NET MVC引入JQUERY JQRTE控件

    ASP.NET MVC引入JQUERY JQRTE控件

    经过将近两周的努力,终于将JQUERY的JQRTE文本编辑器控件引入到了asp.net mvc框架中
    2009-06-06
  • 详解WebApiClient的JsonPatch局部更新

    详解WebApiClient的JsonPatch局部更新

    这篇文章主要介绍了详解WebApiClient的JsonPatch局部更新,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-08-08
  • asp.net DataSet进行排序

    asp.net DataSet进行排序

    关于对已经绑定的DataSet的排序的问题。
    2009-07-07
  • MVC异常处理详解

    MVC异常处理详解

    这篇文章主要为大家详细介绍了MVC异常处理的相关资料,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-06-06
  • ASP.NET批量下载文件的方法

    ASP.NET批量下载文件的方法

    这篇文章主要介绍了ASP.NET批量下载文件的方法,实例汇总了常见的asp.net实现批量下载的方法,具有一定的实用价值,需要的朋友可以参考下
    2014-11-11
  • 限制CheckBoxList控件只能单选实现代码及演示动画

    限制CheckBoxList控件只能单选实现代码及演示动画

    开发要求,原本对CheckBoxList控件是用来让用户多选的。但现在特殊要求,这个CheckBoxList控件限制只能单选,很多新手朋友可能不知从何下手,为此本文的出现时有必要的了,有需要的朋友可以了解此文
    2013-01-01
  • ASP.NET Core中如何实现重定向详解

    ASP.NET Core中如何实现重定向详解

    这篇文章主要给大家介绍了关于ASP.NET Core中如何实现重定向的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-01-01

最新评论