swagger 上传文件 参数_如何使用Swagger上传文件

时间:2025-03-17 16:54:33

前言

随着前后端分离开发模式的普及,后端人员更多是编写服务端API接口。调用接口实现文件上传是一个常见的功能,同时也需要一个选择文件上传的界面,可以编写前端界面上传,可以使用Postman、curl来模拟上传请求。上述的方式多多少少有点麻烦。Swagger作为Api说明文档及调试工具,如果它能提供文件上传的界面(默认不提供),那会更加方便文件上传提示,本文将介绍如何使用Swagger来上传文件。

步骤

1. 安装Swagger

Install-Package

2. 配置Swagger中间件

在中添加:

(c =>

{

("v1", new Info { Title = "My API", Version = "v1" });

});

在中添加:

();

(c =>

{

("/swagger/v1/", "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 (!("POST", ) &&

!("PUT", ))

{

return;

}

var fileParameters = (n => == typeof(IFormFile)).ToList();

if ( < 0)

{

return;

}

("multipart/form-data");

foreach (var fileParameter in fileParameters)

{

var parameter = (n => == );

(parameter);

(new NonBodyParameter

{

Name = ,

In = "formData",

Description = ,

Required = ,

Type = "file"

});

}

}

}

5. 注册SwaggerFileUploadFilter

();

6. 查看结果

POST方法:

PUT方法:

原理解析

使用Swagger的文件上传的关键在于SwaggerFileUploadFilter,它继承于Swashbuckle的IOperationFilter,也即它只作用于Swagger,不会对其它模块造成影响。

我们再来看一下SwaggerFileUploadFilter里面的Apply方法的逻辑:

1. 判断请求的方法是否为POST或者PUT,如果是其它请求方法,基本不可能是文件上传操作。

2. 查找方法中类型为IFormFile的参数。

3. 设置Consumes为“multipart/form-data”。

4. 替换IFormFile类型参数描述中的In为formData、Type为File。

源码地址

参考资料

总结

以上所述是小编给大家介绍的如何使用Swagger上传文件,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对我网站的支持!