如何使用Swagger上傳文件
前言
隨著前后端分離開發(fā)模式的普及，后端人員更多是編寫服務端API接口。調用接口實現(xiàn)文件上傳是一個常見的功能，同時也需要一個選擇文件上傳的界面，可以編寫前端界面上傳，可以使用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<SwaggerFileUploadFilter>();
6. 查看結果
POST方法：
PUT方法：
原理解析
使用Swagger的文件上傳的關鍵在于SwaggerFileUploadFilter，它繼承于Swashbuckle的IOperationFilter，也即它只作用于Swagger，不會對其它模塊造成影響。
我們再來看一下SwaggerFileUploadFilter里面的Apply方法的邏輯：
1. 判斷請求的方法是否為POST或者PUT，如果是其它請求方法，基本不可能是文件上傳操作。
2. 查找方法中類型為IFormFile的參數(shù)。
3. 設置Consumes為“multipart/form-data”。
4. 替換IFormFile類型參數(shù)描述中的In為formData、Type為File。
源碼地址
https://github.com/ErikXu/.NetCoreTips/tree/master/SwaggerFileUpload
參考資料
http://www.talkingdotnet.com/how-to-upload-file-via-swagger-in-asp-net-core-web-api/
總結
以上所述是小編給大家介紹的如何使用Swagger上傳文件，希望對大家有所幫助，如果大家有任何疑問請給我留言，小編會及時回復大家的。在此也非常感謝大家對腳本之家網(wǎng)站的支持！
相關文章
asp.net網(wǎng)站防止SQL注入攻擊，通常的辦法是每個文件都修改加入過濾代碼，這樣很麻煩，下面介紹一種辦法，可以從整個網(wǎng)站防止注入。2009-06-06
這篇文章主要介紹了asp.net中CSharpThinking擴展方法,實例講述了擴展方法的特征及應用,具有一定的參考借鑒價值,需要的朋友可以參考下2014-11-11
動態(tài)加載用戶控件至DataList并為用戶控件賦值實例演示
本文借用使用通用的新聞例子演示動態(tài)加載用戶控件至DataList并為用戶控件賦值，感興趣的朋友可以了解下2013-01-01
這篇文章主要給大家介紹了關于利用Builder方式創(chuàng)建對象的相關資料，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2018-11-11
這篇文章介紹了.Net Core日志記錄之日志配置，文中通過示例代碼介紹的非常詳細。對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2022-06-06
visual studio 2012安裝配置方法圖文教程 附opencv配置教程
這篇文章主要為大家分享了visual studio 2012安裝配置方法圖文教程，文中附opencv配置教程，文中安裝步驟介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2016-05-05
詳解如何在ASP.NET Core中應用Entity Framework
本篇文章主要介紹了如何在ASP.NET Core中應用Entity Framework，具有一定的參考價值，有興趣的可以一起了解一下。2016-12-12
.net驗證碼的刷新或局部刷新的方法實例，下面是實例，需要的朋友可以參考一下2013-03-03
使用.net的方法GetThumbnailImage生成的縮略圖失真嚴重，這里推薦一種不失真生成縮略圖的方法2013-12-12
用Html5與Asp.net MVC上傳多個文件的實現(xiàn)代碼
Html 5 的有一些File API，對Form表單增強的特性，讓我們輕松支持多文件上傳，看下面的Html片斷代碼2012-08-08