使用Swagger直接上傳文件的方法
經常使用swagger，可以通過設置[ProducesResponseType]標記接口的返回信息；swagger也能通過接口的參數列表，自動獲得發(fā)送的數據結構信息。
不過有一個例外，就是上傳文件的時候，設置了[Consumes]的內容為multi-part/form-data，但是swagger并不能正常感知是上傳文件的。代碼是這個樣子的：
關于文件上傳的細節(jié)，可以看多年前我寫過一篇有關通過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進行發(fā)送，不過不能在網頁上直接操作，總覺得心里有點不太舒服。
方法
搜索了一下辦法，比較靠譜的，就是通過增加一個IOperationFilter來實現(xiàn)目的。
// 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的的過濾器，來實現(xiàn)對返回內容的操作。
此方法適用于OAS2，實質上是實現(xiàn)了這里的規(guī)范要求。
我已經用上.NET 5.0了，自帶了swagger都支持的是OpenAPI 3，這個方法不好用了。不過思想應該相同，首先看看OpenAPI 3的規(guī)范，文件上傳需要定義為：
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 };
}
}
}
執(zhí)行之后，swagger已經可以正常識別了，通過選擇文件即可上傳，效果如下：
參考資料
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上傳文件內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
springboot整合netty-mqtt-client實現(xiàn)Mqtt消息的訂閱和發(fā)布示例
本文主要介紹了springboot整合netty-mqtt-client實現(xiàn)Mqtt消息的訂閱和發(fā)布示例，文中根據實例編碼詳細介紹的十分詳盡，具有一定的參考價值，感興趣的小伙伴們可以參考一下2022-03-03
SpringMVC @RequestMapping注解應用方法示例講解
通過@RequestMapping注解可以定義不同的處理器映射規(guī)則,下面這篇文章主要給大家介紹了關于SpringMVC中@RequestMapping注解用法的相關資料,文中通過實例代碼介紹的非常詳細,需要的朋友可以參考下2022-09-09
這篇文章主要介紹了Mybatis中使用updateBatch進行批量更新的相關資料,有逐條更新，sql批量更新等，具體實例代碼大家參考下本文2018-04-04
劍指Offer之Java算法習題精講數組與列表的查找及字符串轉換
跟著思路走，之后從簡單題入手，反復去看，做過之后可能會忘記，之后再做一次，記不住就反復做，反復尋求思路和規(guī)律，慢慢積累就會發(fā)現(xiàn)質的變化2022-03-03
wait()和notify()是直接隸屬于Object類,也就是說所有對象都擁有這一對方法,下面這篇文章主要給大家介紹了關于Java多線程wait()和notify()方法詳細圖解的相關資料,需要的朋友可以參考下2022-10-10
MyBatis實現(xiàn)兩種查詢樹形數據的方法詳解(嵌套結果集和遞歸查詢)
樹形結構數據在開發(fā)中十分常見，比如：菜單數、組織樹， 利用 MyBatis 提供嵌套查詢功能可以很方便地實現(xiàn)這個功能需求。本文主要介紹了兩種方法，感興趣的可以了解一下2021-09-09
在Java編程中,Unicode編碼解碼是一項基本的操作,Unicode是一種用于表示文字字符的標準編碼,它包含了世界上幾乎所有的字符,包括各種語言的字母、符號和表情符號等,在Java中通過Unicode編碼,我們可以將任意字符轉換為字節(jié)流進行傳輸和存儲2024-02-02
這篇文章主要介紹了Java操作MongoDB模糊查詢和分頁查詢的相關資料,需要的朋友可以參考下2016-04-04
詳解Spring 基于 Aspect 注解的增強實現(xiàn)
本篇文章主要介紹了詳解Spring 基于 Aspect 注解的增強實現(xiàn)，非常具有實用價值，需要的朋友可以參考下2017-04-04
在Java中,我們都知道子類不能直接訪問或修改父類的私有屬性,本文主要介紹了Java子類調用父類的私有屬性的實現(xiàn)示例,具有一定的參考價值,感興趣的可以了解一下2024-05-05