swagger 上传文件 参数_如何使用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();
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。
源码地址
参考资料
总结
以上所述是小编给大家介绍的如何使用Swagger上传文件,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对脚本之家网站的支持!
swagger 上传文件 参数_如何使用Swagger上传文件相关推荐
- 大文件分片上传前端框架_基于Node.js的大文件分片上传
基于Node.js的大文件分片上传 我们在做文件上传的时候,如果文件过大,可能会导致请求超时的情况.所以,在遇到需要对大文件进行上传的时候,就需要对文件进行分片上传的操作.同时如果文件过大,在网络不佳 ...
- python第三方库文件传输_本地 Python 代码上传到 Python 第三方库(Pypi)
程序员对于编程都有自己的"套路",好的套路都会得到复用和 IT 界的传播.这时有一个疑问,怎样来实现呢?小编这里就准备介绍如何将自己写的 Python 包上传到 Python 官网 ...
- java scp 文件夹_利用scp 远程上传下载文件/文件夹
scp是secure copy的简写,用于在Linux下进行远程拷贝文件的命令,和它类似的命令有cp,不过cp只是在本机进行拷贝不能跨服务器,而且scp传输是加密的.可能会稍微影响一下速度.当你服务器 ...
- 查询mysql上传大小限制_解决数据库phpmyadmin中上传最大限制:2,048 KB
解决数据库phpmyadmin中上传最大限制:2,048 KB 一.修改php.ini文件. 找到php.ini搜索这3个地方 1.查找post_max_size,指通过表单POST给PHP的所能接收 ...
- js可以打开mat文件吗_企业微信最大可以传多大文件?企业微信发送文件有限制吗?...
使用企业微信营销管理时,可以让我们的工作交流沟通更加高效便捷,在日常办公中,我们时常有传文件的需求,这时就可以使用企业微信进行文件传输,那么你知道企业微信最大可以传多大文件吗?企业微信发文件会有限制吗 ...
- delphi中的函数传参如何传枚举参数_我是这样使用SpringBoot(API传参)
spring boot 传参 spring boot 中的Controller或者RestController接收参数的方法是一样的.这章目标是对几种常用的传参都写个例子. 创建package: co ...
- mac删除文件恢复_如何在Mac上恢复已删除的文件
mac删除文件恢复 Nearly everyone has accidentally deleted a file before. Whether it's family pictures or im ...
- linux swf文件打开_如何在Linux上播放.swf文件?
linux swf文件打开 How to play the flash (.swf) files downloaded from the Web on Linux? 如何在Linux上播放从Web下载 ...
- mac 电脑资源库文件夹_如何在Mac上找到您的资料库文件夹
mac 电脑资源库文件夹 When fixing problems on a Mac, sometimes you need to roll up your sleeves and directly ...
- 启用tim无法访问文件夹_如何在三星手机上启用安全文件夹
启用tim无法访问文件夹 The Secure Folder is a useful feature on Samsung devices that allows you to keep apps a ...
最新文章
- 机器人造iPhone,苹果奋斗八年,还是败给了富士康工人
- Java中的注解以及应用 @Deprecated @SupressWarning @Override
- BugkuCTF-WEB题秋名山车
- 倒数58天 -- 分治法 -- 使用循环求方程的一个解
- sm2算法c 语言实现,移远通信集成国密安全解决方案的C-V2X AP模组商用落地
- html5导出错误,JavaScript:toDataUrl()抛出“安全错误:可能无法导出受污染的画布”. - 程序园...
- XDUOJ 1125 Judgement of Orz Pandas
- eclipse常用快捷键整理
- OFFICE拼写语法检查:全部忽略、全部更正的功能
- android zip winrar,WinRAR Zip Unzip Archive
- 计算机基础视频教程B站版
- c#winform panel空间拖动窗体 最小化 关闭 按钮 右下角弹窗
- 华为设备的安全配置console及telnet
- 金昌搜索引擎优化网络推广_金昌网站推广,金昌网站推广平台,金昌企业网站推广-奇秀云AI智能推广系统-奇秀网...
- 网传美团今年应届生年薪 35w+,严重倒挂老员工,为什么互联网大厂校招的薪资一年比一年高?...
- 学习笔记:全局变量定义“无须”初始化,局部变量必须初始化
- 通过修改hosts文件屏蔽网站的广告
- Theta*: 连续环境下平滑的任意角度的路径规划
- 第五章 Java API(九)
- 傅里叶变换家族的关系
热门文章
- 机器视觉算法与应用001
- java url编码和js的url编码_Java URLEncoder与URLDecoder编码解码使用示例
- 通过ajax获取经纬度,通过百度地图获取经纬度
- x9此计算机上没有hasp_中琅条码打印软件安装后弹出HASP错误代码处理方法
- VS2010-MFC(常用控件:标签控件Tab Control 上)
- 数据结构与算法(C语言版)——陈越
- linux和windows精简版,win7 64/86 超级精简版877MB -三蛋作品
- 基于qt开发的轻量级浏览器
- 怎么对神经网络重新训练,神经网络重建
- 【CTF】关于md5总结