使用Swagger直接上传文件的方法

 更新时间:2020年12月31日 08:42:12   作者:波多尔斯基  
这篇文章主要介绍了使用Swagger直接上传文件的方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

经常使用swagger,可以通过设置[ProducesResponseType]标记接口的返回信息;swagger也能通过接口的参数列表,自动获得发送的数据结构信息。

不过有一个例外,就是上传文件的时候,设置了[Consumes]的内容为multi-part/form-data,但是swagger并不能正常感知是上传文件的。代码是这个样子的:

关于文件上传的细节,可以看多年前我写过一篇有关通过WEBAPI上传文件的文章

[Consumes("multipart/form-data")]
[ODataRoute]
[HttpPost]
public async Task<ActionResult> Post(IFormCollection collection)
{
 var file = collection.Files[0];
 if(file != null)
 {
 var filename = DateTime.Now.ToString("yyyyMMddHHmmss") + file.FileName;
 var path = Path.Combine(_webHostEnvironment.WebRootPath, "Files", filename);
 using FileStream fileStream = new FileStream(path, FileMode.Create);
 await file.CopyToAsync(fileStream);
 var uri = "Files/" + filename;
 var fileEntity = new Models.File { Url = uri, LastModified = DateTime.Now };
 _homeworkDataContext.Files.Add(fileEntity);
 await _homeworkDataContext.SaveChangesAsync();
 return Created(WebUtility.UrlEncode(uri), fileEntity);
 }
 return BadRequest();
}

实际上,swagger一直提示,上传的内容是一个array类型,当然API是没有问题的,可以通过POSTMAN进行发送,不过不能在网页上直接操作,总觉得心里有点不太舒服。

方法

搜索了一下办法,比较靠谱的,就是通过增加一个IOperationFilter来实现目的。

// CODE FROM https://www.talkingdotnet.com/how-to-upload-file-via-swagger-in-asp-net-core-web-api/
public class FileUploadOperation : IOperationFilter
{
 public void Apply(Operation operation, OperationFilterContext context)
 {
 if (operation.OperationId.ToLower() == "apivaluesuploadpost")
 {
  operation.Parameters.Clear();
  operation.Parameters.Add(new NonBodyParameter
  {
  Name = "uploadedFile",
  In = "formData",
  Description = "Upload File",
  Required = true,
  Type = "file"
  });
  operation.Consumes.Add("multipart/form-data");
 }
 }
}

然后,在services.ConfigureSwaggerGen()参数中,添加

options.OperationFilter<FileUploadOperation>(); 

方法的原理是通过重写操作某个特定API的的过滤器,来实现对返回内容的操作。

此方法适用于OAS2,实质上是实现了这里的规范要求。

我已经用上.NET 5.0了,自带了swagger都支持的是OpenAPI 3,这个方法不好用了。不过思想应该相同,首先看看OpenAPI 3的规范,文件上传需要定义为:

requestBody:
 content:
 multipart/form-data:
 schema:
 type: object
 properties:
  fileName:
  type: string
  format: binary

这个套路和OpenAPI 2完全不一样,需要重新设置requestBody才行。我们按照要求改造代码。

public class FileUploadOperation : IOperationFilter
{
 public void Apply(OpenApiOperation operation, OperationFilterContext context)
 {
 //判断上传文件的类型,只有上传的类型是IFormCollection的才进行重写。
 if (context.ApiDescription.ActionDescriptor.Parameters.Any(w => w.ParameterType == typeof(IFormCollection)))
 {
  Dictionary<string, OpenApiSchema> schema = new Dictionary<string, OpenApiSchema>();
  schema["fileName"] = new OpenApiSchema { Description = "Select file", Type = "string", Format = "binary" };
  Dictionary<string, OpenApiMediaType> content = new Dictionary<string, OpenApiMediaType>();
  content["multipart/form-data"] = new OpenApiMediaType { Schema = new OpenApiSchema { Type = "object", Properties = schema } };
  operation.RequestBody = new OpenApiRequestBody() { Content = content };
 }
 }
}

执行之后,swagger已经可以正常识别了,通过选择文件即可上传,效果如下:

参考资料

https://docs.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-5.0&tabs=visual-studio

https://docs.microsoft.com/en-us/aspnet/core/mvc/models/file-uploads?view=aspnetcore-5.0

https://www.talkingdotnet.com/how-to-upload-file-via-swagger-in-asp-net-core-web-api/

到此这篇关于使用Swagger直接上传文件的方法的文章就介绍到这了,更多相关Swagger上传文件内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • jcl与jul log4j1 log4j2 logback日志系统机制及集成原理

    jcl与jul log4j1 log4j2 logback日志系统机制及集成原理

    这篇文章主要介绍了jcl与jul log4j1 log4j2 logback的集成原理,Apache Commons-logging 通用日志框架与日志系统的机制,有需要的朋友可以借鉴参考下
    2022-03-03
  • SpringBoot读取资源目录中JSON文件的方法实例

    SpringBoot读取资源目录中JSON文件的方法实例

    最近做项目遇到需要将json类型的配置文件引用到项目中,已经将读取json文件的方法封装成工具类,下面这篇文章主要给大家介绍了关于SpringBoot读取资源目录中JSON文件的相关资料,需要的朋友可以参考下
    2023-04-04
  • Java+OpenCV实现图片中的人脸识别

    Java+OpenCV实现图片中的人脸识别

    这篇文章主要介绍了如何利用java opencv实现人脸识别功能,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-03-03
  • java基础之Collection与Collections和Array与Arrays的区别

    java基础之Collection与Collections和Array与Arrays的区别

    这篇文章主要介绍了java基础之Collection与Collections和Array与Arrays的区别的相关资料,本文主要说明两者的区别以防大家混淆概念,需要的朋友可以参考下
    2017-08-08
  • AQS加锁机制Synchronized相似点详解

    AQS加锁机制Synchronized相似点详解

    这篇文章主要为大家介绍了AQS加锁机制Synchronized相似点详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-10-10
  • 详解SpringMVC中拦截器的概念及入门案例

    详解SpringMVC中拦截器的概念及入门案例

    拦截器(Interceptor)是一种动态拦截方法调用的机制,在SpringMVC中动态拦截控制器方法的执行。本文将详细讲讲SpringMVC中拦截器的概念及入门案例,感兴趣的可以尝试一下
    2022-07-07
  • Java实战之用hutool-db实现多数据源配置

    Java实战之用hutool-db实现多数据源配置

    在微服务搭建中经常会使用到多数据库情形这个时候,下面这篇文章主要给大家介绍了关于Java实战之用hutool-db实现多数据源配置的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考下
    2022-12-12
  • SpringBoot前后端接口对接常见错误小结

    SpringBoot前后端接口对接常见错误小结

    SpringBoot前后端接口对接工作时,经常遇到请求500,400等问题,本文主要介绍了SpringBoot前后端接口对接常见错误小结,感兴趣的可以了解一下
    2022-01-01
  • 利用Java实现调用http请求

    利用Java实现调用http请求

    在实际开发过程中,我们经常需要调用对方提供的接口或测试自己写的接口是否合适。本文就为大家准备了几个java调用http请求的几种常见方式,需要的可以参考一下
    2022-08-08
  • 深入了解Spring中getBean()的五种方式

    深入了解Spring中getBean()的五种方式

    在本文中,我们将详细介绍从BeanFactory中获取bean的多种方式。简单地说,正如方法的名称所表达的,getBean()负责从Spring IOC容器中获取bean实例,希望对大家有所帮助
    2023-02-02

最新评论