.Net Core小技巧 - 使用Swagger上传文件

前言

   随着前后端分离开发模式的普及,后端人员更多是编写服务端API接口。调用接口实现文件上传是一个常见的功能,同时也需要一个选择文件上传的界面,可以编写前端界面上传,可以使用Postman、curl来模拟上传请求。上述的方式多多少少有点麻烦。Swagger作为Api说明文档及调试工具,如果它能提供文件上传的界面(默认不提供),那会更加方便文件上传提示,本文将介绍如何使用Swagger来上传文件。

 

步骤

1. 安装Swagger

Install-Package Swashbuckle.AspNetCore

640?wx_fmt=png&wxfrom=5&wx_lazy=1

 

2. 配置Swagger中间件

在Startup.ConfigureServices中添加:

services.AddSwaggerGen(c =>{c.SwaggerDoc("v1", new Info { Title = "My API", Version = "v1" });
});

640?wx_fmt=png&wxfrom=5&wx_lazy=1

 

在Startup.Configure中添加:

app.UseSwagger();app.UseSwaggerUI(c =>{c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
});

640?wx_fmt=png

 

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>();

640?wx_fmt=png

 

6. 查看结果

POST方法:

640?wx_fmt=png

640?wx_fmt=png

 

PUT方法:

640?wx_fmt=png

640?wx_fmt=png

 

原理解析

  使用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

640?wx_fmt=jpeg

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/321524.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

【动态规划】数字金字塔

数字金字塔 Description 考虑在下面被显示的数字金字塔。 写一个程序来计算从最高点开始在底部任意处结束的路径经过数字的和的最大。 每一步可以走到左下方的点也可以到达右下方的点。 7 3 8 8 1 0 2 7 4 4 4 5 2 6 5 在上面的样例中,从7 到 3 到 8 到 7 到 5 的路径…

读极致产品

1、极致产品 用户的痛点&#xff0c;项目的需求是什么&#xff1f;准确吗&#xff1f;是不是真需求&#xff1f;如何抓住用户的真需求&#xff0c;如何深入用户需求做产品。要站在用户的角度思考问题&#xff0c;了解用户的刚需、痛点。商业的本质是让人性得到释放&#xff0c;…

P4555-[国家集训队]最长双回文串【Manacher】

正题 题目链接:https://www.luogu.com.cn/problem/P4555 题目大意 长度为nnn的串&#xff0c;双回文串的定义是两个连续的回文串&#xff0c;求最长的双回文串。 解题思路 我们用马拉车维护pip_ipi​的时候维护一个lil_ili​和rir_iri​。 li:l_i:li​:以iii开头的最长回文串…

容器化分布式日志组件ExceptionLess的Angular前端UI

写在前面随着微服务架构的流行&#xff0c;日志也需要由专门的分布式日志组件来完成这个工作&#xff0c;我们项目使用的是 ExceptionLess 这个组件&#xff0c;它是前后端分离的&#xff1b;这篇文章我们就来实践容器化 ExceptionLess 的前端&#xff0c;并为其包含一个 nginx…

读人人都是产品经理__1

1、产品经理 设计产品的一大准则就是无需阅读说明书就能上手&#xff0c;如何让用户用起来更加省心是产品改进的方向&#xff0c;产品就是用来解决某个问题的东西&#xff0c;产品可以是有形的实物&#xff0c;也可以是无形的服务。只有能解决问题&#xff0c;产品才能有价值。…

【动态规划】最小代价问题

最小代价问题 Description 设有一个nm(小于100)的方格&#xff08;如图所示&#xff09;&#xff0c;在方格中去掉某些点&#xff0c;方格中的数字代表距离&#xff08;为小于100的数&#xff0c;如果为0表示去掉的点&#xff09;&#xff0c;试找出一条从A(左上角)到B&#…

jzoj3859-孤独一生【dp,树状数组】

正题 题目链接:https://jzoj.net/senior/#main/show/3859 题目大意 nnn个台阶&#xff0c;第iii个高度为hih_ihi​&#xff0c;把它分为两个集合&#xff0c;使得两个集合中相邻的hih_ihi​差值和最小。 解题思路 设fif_ifi​表示刚好处理到iii且目前集合开头是iii的最小差值…

EF 6.x、EF Core实现dynamic动态查询和EF Core实现多个上下文实例池你了解多少?

前言很长一段时间没有写博客了&#xff0c;今天补上一篇吧&#xff0c;偶尔发现不太愿意写博客了&#xff0c;太耗费时间&#xff0c;不过还是在坚持当中&#xff0c;毕竟或许写出来的东西能帮到一些童鞋吧&#xff0c;接下来我们直奔主题。无论是在在EF 6.x还是EF Core中对于原…

1、play编程基础

1、Action、Controller、Result Action指的是动作&#xff0c;play中大多数请求可以使用action来处理&#xff0c;一个请求对应一个动作也就是一个java方法&#xff0c;然后处理请求返回一个响应&#xff0c;这个响应用Result来体现 Controller就是一个继承了 play.mvc.Contro…

【动态规划】城市交通

城市交通 Description 有n个城市&#xff0c;编号1~n&#xff0c;有些城市之间有路相连&#xff0c;有些则没有&#xff0c;有路则当然有一个距离。现在规定只能从编号小的城市到编号大的城市&#xff0c;问你从编号为1的城市到编号为n的城市之间的最短距离是多少&#xff1f…

AspNetCoreApi 跨域处理(CORS )

如果咱们有处理过MV5 跨域问题这个问题也不大。&#xff08;1&#xff09;为什么会出现跨域问题&#xff1a;浏览器安全限制了前端脚本跨站点的访问资源&#xff0c;所以在调用WebApi 接口时不能成功访问资源&#xff0c;原因“同源策略”的存在&#xff1a;同源指以下几点相同…

【动态规划】求最长不下降序列

求最长不下降序列求最长不下降序列求最长不下降序列 Description 设有n(n<1000)个不相同的整数(小于32767)组成的数列&#xff0c;记为&#xff1a; a1,a2,…,an,其中任意两个数不相同。 例如&#xff1a;3,18,7,14,10,12,23,41,16,24。 若有 且有 。则称为长度为e的不…

jzoj3860-地壳运动(mst)【最小生成树,三分】

正题 题目链接:https://jzoj.net/senior/#contest/show/3002/1 题目大意 nnn个点mmm条边&#xff0c;每条边有(u,v)(u,v)(u,v)两个权值。 qqq个询问&#xff0c;每次询问一个(k1,k2)(k1,k2)(k1,k2)&#xff0c;将所有边的权值变为u∗k1v∗k2u*k1v*k2u∗k1v∗k2后求最小生成树。…

读人人都是产品经理__2

1、做产品和做项目 对产品经理来说&#xff0c;最重要的是判断力和创造力&#xff0c;产品经理决定做不做、做什么&#xff0c;保证方向正确&#xff0c;要把它实现。对项目经理来说&#xff0c;最终的是执行力和控制力&#xff0c;项目经理决定怎么做&#xff0c;谁来做&#…

业务配置开发平台qMISPlat 2.0 产品介绍

qMISPlat是什么qMISPlat(业务配置开发平台)是一套基于.net core 2.0、跨平台的&#xff0c;面向开发人员和具有一定技术水平的业务人员使用的业务配置开发平台。基于此平台您只需通过配置和少量开发即可快速搭建满足用户需求的业务系统&#xff0c;大大降低项目开发工作量。平台…

jzoj2755-[2012东莞市选]树的计数【dp,高精度】

正题 题目链接:https://jzoj.net/senior/#main/show/2755 题目大意 求有多少个nnn个点直径为ddd的标号树。 解题思路 定义fi,jf_{i,j}fi,j​表示iii个点&#xff0c;深度不超过jjj的标号树数量。 然后有转移fi,j∑k1i−1Ci−2k−1∗k∗fk,j−1∗fi−k,jf_{i,j}\sum_{k1}^{i…

2、异步HTTP编程

1、处理异步结果 在内部&#xff0c;play框架是自下而上异步的。Play以异步、非阻塞方式处理每个请求。应用程序代码应尽量避免阻塞控制器&#xff0c;这种阻塞操作的常见例子有JDBC调用、流式API、HTTP请求和长计算。因此应尽量通过保持控制器异步的方法使得应用进行扩展&…

【动态规划】最大子矩阵之和

最大子矩阵 Description 给出一个N [2<N<100]&#xff0c;并给出一个N*N的矩阵&#xff0c;矩阵中的数为[-127,127]之间。求出矩阵中一块子矩阵的最大和。 比如&#xff1a; 0 -2 -7 0 9 2 -6 2 -4 1 -4 1 -1 8 0 -2 和最大的子矩阵应该是这个&#xff1a; 9 2 …

3、play中的模板引擎

1、模板格式 Play默认的模板引擎是一种基于scala的安全模板引擎&#xff0c;尽管模板引擎使用Scala作为表达式语言&#xff0c;但是非常简单易学。参数类型使用后缀语法指定&#xff08;例如&#xff1a; id&#xff1a;Long&#xff09;&#xff0c;泛型类型是使用[]符号&…

jzoj3500-物语【最短路】

正题 题目链接:https://jzoj.net/senior/#contest/show/3005/0 题目大意 nnn个点mmm条边的无向图&#xff0c;有一条边的边权会变化&#xff0c;qqq次变化&#xff0c;每次询问最短路。 解题思路 可变边(x,y)(x,y)(x,y) 路径无非就三种 1−>n1->n1−>n1−>x−>…