文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

如何使用最小WEB API实现文件上传

2023-06-29 06:03

关注

这篇文章主要介绍“如何使用最小WEB API实现文件上传”的相关知识,小编通过实际案例向大家展示操作过程,操作方法简单快捷,实用性强,希望这篇“如何使用最小WEB API实现文件上传”文章能帮助大家解决问题。

前言:

我们使用最小 WEB API 实现文件上传功能,虽然客户端访问是正常的,但是当打开 Swagger 页面时,发现是这样的:

如何使用最小WEB API实现文件上传

没法使用 Swagger 页面测试。

一、允许 Content Type

正常的 Swagger 页面应该是这样的:

如何使用最小WEB API实现文件上传

看来,我们需要指定 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 :

如何使用最小WEB API实现文件上传

看来,只有自定义 Swagger 页面了。

二、自定义 OperationFilter

在 OpenAPI 3.0 中,文件上传的请求可以用下列结构描述:

如何使用最小WEB API实现文件上传

而在 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实现文件上传

关于“如何使用最小WEB API实现文件上传”的内容就介绍到这里了,感谢大家的阅读。如果想了解更多行业相关的知识,可以关注编程网行业资讯频道,小编每天都会为大家更新不同的知识点。

阅读原文内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     807人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     351人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     314人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     433人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     221人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯