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

编程开发   © 文章版权由 admin 解释,禁止匿名转载

#楼主# 2020-12-30

经常使用swagger,可以通过设置[ProducesResponseType]标记接口的返回信息;swagger也能通过接口的参数列表,自动获得发送的数据结构信息。不过有一个例外,就是上传文件的时候,设置了[Consumes]的内容为multi-part/form-data,但是swagger并不能正常感知是上传文件的。代码是这个样子的:[Consumes("multipart/form-data")][ODataRoute][HttpPost]public async Task 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来实现目的。Copy// CODE FROM

本帖含有隐藏内容,请您 回复 后查看
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()参数中,添加Copyoptions.OperationFilter(); 方法的原理是通过重写操作某个特定API的的过滤器,来实现对返回内容的操作。

成为第一个回答人

评论

登录后才可发表内容
  • 主题

    10

  • 帖子

    48

  • 关注者

    0

Copyright © 2019 凯特网.   Powered by HYBBS 2.3.4  

Runtime:0.0897s Mem:2051Kb