使用Swagger上传文件的方法-创新互联
这篇文章给大家分享的是有关使用Swagger上传文件的方法的内容。小编觉得挺实用的,因此分享给大家做个参考,一起跟随小编过来看看吧。
成都创新互联公司专注于企业成都营销网站建设、网站重做改版、两当网站定制设计、自适应品牌网站建设、H5开发、电子商务商城网站建设、集团公司官网建设、成都外贸网站建设公司、高端网站制作、响应式网页设计等建站业务,价格优惠性价比高,为两当等各大城市提供网站开发制作服务。前言
随着前后端分离开发模式的普及,后端人员更多是编写服务端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。
源码地址
https://github.com/ErikXu/.NetCoreTips/tree/master/SwaggerFileUpload
感谢各位的阅读!关于“使用Swagger上传文件的方法”这篇文章就分享到这里了,希望以上内容可以对大家有一定的帮助,让大家可以学到更多知识,如果觉得文章不错,可以把它分享出去让更多的人看到吧!
新闻名称:使用Swagger上传文件的方法-创新互联
文章来源:http://azwzsj.com/article/dodsge.html