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

时间:2021-05-19

经常使用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:///how-to-upload-file-via-swagger-in-asp-net-core-web-api/

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

声明:本页内容来源网络,仅供用户参考;我单位不保证亦不表示资料全面及准确无误,也不保证亦不表示这些资料为最新信息,如因任何原因,本网内容或者用户因倚赖本网内容造成任何损失或损害,我单位将不会负任何法律责任。如涉及版权问题,请提交至online#300.cn邮箱联系删除。

相关文章