使用Swagger上傳文件的方法

這篇文章給大家分享的是有關(guān)使用Swagger上傳文件的方法的內(nèi)容。小編覺得挺實(shí)用的，因此分享給大家做個參考，一起跟隨小編過來看看吧。

前言

 　　隨著前后端分離開發(fā)模式的普及，后端人員更多是編寫服務(wù)端API接口。調(diào)用接口實(shí)現(xiàn)文件上傳是一個常見的功能，同時也需要一個選擇文件上傳的界面，可以編寫前端界面上傳，可以使用Postman、curl來模擬上傳請求。上述的方式多多少少有點(diǎn)麻煩。Swagger作為Api說明文檔及調(diào)試工具，如果它能提供文件上傳的界面（默認(rèn)不提供），那會更加方便文件上傳提示，本文將介紹如何使用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. 查看結(jié)果

POST方法：

PUT方法：

原理解析

　　使用Swagger的文件上傳的關(guān)鍵在于SwaggerFileUploadFilter，它繼承于Swashbuckle的IOperationFilter，也即它只作用于Swagger，不會對其它模塊造成影響。

　　我們再來看一下SwaggerFileUploadFilter里面的Apply方法的邏輯：

　　1. 判斷請求的方法是否為POST或者PUT，如果是其它請求方法，基本不可能是文件上傳操作。

　　2. 查找方法中類型為IFormFile的參數(shù)。

　　3. 設(shè)置Consumes為“multipart/form-data”。

　　4. 替換IFormFile類型參數(shù)描述中的In為formData、Type為File。

源碼地址

https://github.com/ErikXu/.NetCoreTips/tree/master/SwaggerFileUpload

感謝各位的閱讀！關(guān)于“使用Swagger上傳文件的方法”這篇文章就分享到這里了，希望以上內(nèi)容可以對大家有一定的幫助，讓大家可以學(xué)到更多知識，如果覺得文章不錯，可以把它分享出去讓更多的人看到吧！