.net core webapi 文件上传在 Swagger 文档中的有好提示处理

前提：

　　需要nuget Swashbuckle.AspNetCore 我暂时用的是 4.01 最新版本；

描述：解决 .net core webapi 上传文件使用的是 IFormFile，在Swagger 接口描叙的时候很不友好，为解决接口文档的友好描叙；

实际效果：

解决办法：

　　步骤1 增加 Swagger 的选项过滤器 SwaggerFileUploadFilter.cs

/// <summary>/// Swagger 上传文件过滤器/// </summary>public class SwaggerFileUploadFilter : IOperationFilter{/// <summary>/// 应用过滤器/// </summary>/// <param name="operation"></param>/// <param name="context"></param>public void Apply(Operation operation, OperationFilterContext context){#region 文件上传处理if (!context.ApiDescription.HttpMethod.Equals("POST", StringComparison.OrdinalIgnoreCase) &&!context.ApiDescription.HttpMethod.Equals("PUT", StringComparison.OrdinalIgnoreCase)){return;}var fileParameters = context.ApiDescription.ActionDescriptor.Parameters.Where(n => n.ParameterType == typeof(IFormFile)).ToList();if (fileParameters.Count < 0){return;}operation.Consumes.Add("multipart/form-data");foreach (var fileParameter in fileParameters){var parameter = operation.Parameters.Single(n => n.Name == fileParameter.Name);operation.Parameters.Remove(parameter);operation.Parameters.Add(new NonBodyParameter{Name = parameter.Name,In = "formData",Description = parameter.Description,Required = parameter.Required,Type = "file"});}#endregion}}

　　步骤2 对 startup.cs swagger 配置项进行过滤

            services.AddSwaggerGen(options =>{..........options.OperationFilter<SwaggerFileUploadFilter>();});

转载于:https://www.cnblogs.com/intotf/p/10075162.html

.net core webapi 文件上传在 Swagger 文档中的有好提示处理相关推荐

php 上传ppt,PHP实现文件上传PPT精品文档
<PHP实现文件上传PPT精品文档>由会员分享,可在线阅读,更多相关<PHP实现文件上传PPT精品文档(11页珍藏版)>请在人人文库网上搜索. 1.1,PHP实现HTTP文件上 ...
Vue + Element+ ASP.NET Core WebAPI 文件上传下载
以ASP.NET Core WebAPI 作后端 API ,用 Vue 构建前端页面,用 Axios 从前端访问后端 API ,包括文件的上传和下载. 准备asp.net后端文件上传的API Uplo ...
【工具】更新云文档办公利器汇总，腾讯新增批量上传多文件上传，云文档对比测试报告...
昨天腾讯文档增加了新功能:一键批量文件导入,即一次操作将多个文件导入到腾讯文档.简单测试了一下,非常好用.腾讯文档要往云存储方向发展?小伙伴们又多了一个云备份地方,好评! 上次的大文件上传测试在论坛 ...
【工具】更新云文档办公利器汇总，腾讯文档测试文件上传，云文档对比测试报告...
昨天在论坛里看到有大神分享"书籍索引目录.xlsx",据说是某宝买的资源,里边是约5T电子书资源的网盘书籍引目录,这个excel表格文档大小6M左右,我想分享给大家,然后便有了今天 ...
html上传文件框架,文件上传 - FastAdmin框架文档 - FastAdmin开发文档
文件上传最后更新时间:2021-01-15 17:29:11 FastAdmin支持将文件.图片.视频.压缩包等文件快速的上传至本地服务器或云存储,同时支持云存储直传模式和服务器进行中转模式. 你可 ...
想说爱你不容易 | 使用最小 WEB API 实现文件上传（Swagger 支持）
前言上回,我们使用最小 WEB API 实现文件上传功能(<想说爱你不容易 | 使用最小 WEB API 实现文件上传>),虽然客户端访问是正常的,但是当打开 Swagger 页面时,发 ...
.Net Core 图片文件上传下载
当下.Net Core项目可是如雨后春笋一般发展起来,作为.Net大军中的一员,我热忱地拥抱了.Net Core并且积极使用其进行业务的开发,我们先介绍下.Net Core项目下实现文件上传下载接口. ...
淘宝铺货上传商品API文档
1.订购链接:月功能费__元(登录后显示正常价格) 2.授权拿到ssion_id 3.调用万邦的 custom接口 (注册使用) 参数要传授权的session,参数和淘宝官方的一致 (如:上传商品接 ...
JAVA删除pdf空白页_如何编辑PDF文件，如何删除PDF文档中的空白页
时代在发展,科技在进步,我们现在日常使用的文件也发展了,以前只有Word跟TXT,现在还增加了一个PDF格式的文件,但PDF格式的文件跟Word和TXT文件不一样,Word跟TXT文件可以直接的打开编 ...

.net core webapi 文件上传在 Swagger 文档中的有好提示处理

.net core webapi 文件上传在 Swagger 文档中的有好提示处理相关推荐

最新文章

热门文章