快捷導(dǎo)航

如何使用Swagger上傳文件

更新時(shí)間：2018年05月14日 16:09:18 作者：編程玩家

本文將介紹如何使用Swagger來上傳文件。本文分步驟給大家介紹的非常詳細(xì)，感興趣的朋友跟隨腳本之家小編一起學(xué)習(xí)吧

前言

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

c.OperationFilter<SwaggerFileUploadFilter>();

6. 查看結(jié)果

POST方法：