.Net Core小技巧 - 使用Swagger上传文件
前言
随着前后端分离开发模式的普及,后端人员更多是编写服务端API接口。调用接口实现文件上传是一个常见的功能,同时也需要一个选择文件上传的界面,可以编写前端界面上传,可以使用Postman、curl来模拟上传请求。上述的方式多多少少有点麻烦。Swagger作为Api说明文档及调试工具,如果它能提供文件上传的界面(默认不提供),那会更加方便文件上传提示,本文将介绍如何使用Swagger来上传文件。
步骤
1. 安装Swagger
Install-Package Swashbuckle.AspNetCore
2. 配置Swagger中间件
在Startup.ConfigureServices中添加:
services.AddSwaggerGen(c =>{c.SwaggerDoc("v1", new Info { Title = "My API", Version = "v1" }); });
在Startup.Configure中添加:
app.UseSwagger();app.UseSwaggerUI(c =>{c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1"); });
3. 编写API
// POST api/values
[HttpPost]
public void Post(IFormFile file)
{
//TODO:Save file...
}
// PUT api/values/5
[HttpPut("{id}")]
public void Put(int id, IFormFile file)
{
//TODO:Save file...
}
4. 编写SwaggerFileUploadFilter
public class SwaggerFileUploadFilter : IOperationFilter
{
public void Apply(Operation operation, OperationFilterContext context)
{
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"
});
}
}
}
5. 注册SwaggerFileUploadFilter
c.OperationFilter<SwaggerFileUploadFilter>();
6. 查看结果
POST方法:
PUT方法:
原理解析
使用Swagger的文件上传的关键在于SwaggerFileUploadFilter,它继承于Swashbuckle的IOperationFilter,也即它只作用于Swagger,不会对其它模块造成影响。
我们再来看一下SwaggerFileUploadFilter里面的Apply方法的逻辑:
1. 判断请求的方法是否为POST或者PUT,如果是其它请求方法,基本不可能是文件上传操作。
2. 查找方法中类型为IFormFile的参数。
3. 设置Consumes为“multipart/form-data”。
4. 替换IFormFile类型参数描述中的In为formData、Type为File。
源码地址
https://github.com/ErikXu/.NetCoreTips/tree/master/SwaggerFileUpload
参考资料
http://www.talkingdotnet.com/how-to-upload-file-via-swagger-in-asp-net-core-web-api/
原文地址 :https://www.cnblogs.com/Erik_Xu/p/8904854.html
.NET社区新闻,深度好文,欢迎访问公众号文章汇总 http://www.csharpkit.com
.Net Core小技巧 - 使用Swagger上传文件相关推荐
- cmd echo写入shell_渗透技巧——通过cmd上传文件的N种方法
0x00 前言 在渗透测试的过程中,常常需要向目标主机上传文件,我在最近的学习测试过程中就碰到了这个问题,要求只能通过cmd shell向目标主机(Windows系统)上传文件,所以本文就对该技巧做一 ...
- 小程序用thinkPHP上传文件到腾讯云对象存储空间
<?php/*** Created by PhpStorm.* User: Administrator* Date: 2017/11/22* Time: 10:48*/namespace Hom ...
- 微信小程序-云开发上传文件、图片
文章目录 一.前言 二.功能简介 1.选择微信聊天记录中的文件 2.选择本地相册/拍照图片 3.上传功能 三.实现代码 1.选择聊天文件函数(js) 2.选择相册函数(js) 3.上传文件函数(js) ...
- 微信小程序从聊天记录上传文件(上传后可预览)
1.由于微信小程序不支持 <input type="file">且uni.chooseImage只能上传图片 2.uview组件库 只支持H5 <u-upload ...
- asp.net core MVC程序通过AJAX上传文件报“400 Bad Request”
微软asp.net core上传文件示例中的流式文件上传示例采用AJAX调用控制器函数上传,但是将此部分代码剥离出来运行时,会报下图所示的"400 Bad Request"的错 ...
- swagger 上传文件 参数_Swagger发送body和formData参数
我正在使用Swagger 2.0,我有一个问题是发送多个帖子参数 . 我有一个招摇错误 Operation cannot have a body parameter and a formData pa ...
- 小程序: wx.uploadFile上传文件保持原文件名的方法
其实很简单: formData中携带文件名即可! 废放不说,上源码: 小程序端: js: uploadSendFile(file){ //fi ...
- swagger 上传文件接口Api 无上传文件按钮
检查了serviceImpl代码没有错 找了半天发现是controller层的方法参数列表没有添加 @RequestPart注解
- php怎么保存上传的文件夹里,PHP上传文件 保存到文件夹或数据库
写到数据库: $filepath = $_FILES["uploadfile"]["name"]; $formdata=$_FILES["upload ...
最新文章
- 谁在引领中国制造?中国智能制造发展解析
- Visual C++ MFC/ATL开发-高级篇(一)
- sql每一个join都要加on
- Properties类详细解析
- python协程框架_FastPy3.0 发布,高性能 python 协程web框架
- SAP云平台部署HTML5应用时的错误消息Failed to report quota consumption
- 备份ad_IT管理公开课——备份恢复解决方案
- flex include和import
- 装文件存储服务器Fastdfs
- 计算机管理器鼠标不见了怎么办,电脑的鼠标光标消失了
- 寄存器(RAL)模型中的write方法
- 文件上传/JS/MIME/黑名单/白名单/htaccess/00截断详解篇[代码审计]
- 专访架构师周爱民:谈企业软件架构设计 1
- 北京国家计算机四级网络工程师,关于国家计算机四级网络工程师的介绍
- CANoe.DiVa 操作指南 -测试覆盖度分析
- 自动编码器检测检测信用卡欺诈
- JSP PreparedStatement.setDate
- 微软群集MSCS系统介绍
- 双显卡双显示输出,怎么设置默认显卡为集显
- Spring源码分析——IOC容器