使用最小 WEB API 实现文件上传的Swagger支持
前言:
上回,我们使用最小 WEB API 实现文件上传功能《 使用最小 WEB API 实现文件上传会遇到的坑》,虽然客户端访问是正常的,但是当打开 Swagger 页面时,发现是这样的:
没法使用 Swagger
页面测试。
一、允许 Content Type
正常的 Swagger 页面应该是这样的:
看来,我们需要指定 Content Type:
app.MapPost("/upload", async (HttpRequest request) => { var form = await request.ReadFormAsync(); return Results.Ok(form.Files.First().FileName); }).Accepts<HttpRequest>("multipart/form-data");
结果,Swagger 页面变成了这样,增加了一堆 Form 相关属性,唯独没有 file :
看来,只有自定义 Swagger 页面了。
二、自定义 OperationFilter
在 OpenAPI 3.0 中,文件上传的请求可以用下列结构描述(https://swagger.io/docs/specification/describing-request-body/file-upload/):
而在 Swashbuckle
中,可以使用 IOperationFilter
接口实现操作筛选器,控制如何定义 Swagger UI
的行为。
在这里,我们将利用 RequestBody
对象来实现上述的文件上传的请求结构。
public class FileUploadOperationFilter : IOperationFilter { public void Apply(OpenApiOperation operation, OperationFilterContext context) { const string FileUploadContentType = "multipart/form-data"; if (operation.RequestBody == null || !operation.RequestBody.Content.Any(x => x.Key.Equals(FileUploadContentType, StringComparison.InvariantCultureIgnoreCase))) { return; } if (context.ApiDescription.ParameterDescriptions[0].Type == typeof(HttpRequest)) { operation.RequestBody = new OpenApiRequestBody { Description = "My IO", Content = new Dictionary<String, OpenApiMediaType> { { FileUploadContentType, new OpenApiMediaType { Schema = new OpenApiSchema { Type = "object", Required = new HashSet<String>{ "file" }, Properties = new Dictionary<String, OpenApiSchema> { { "file", new OpenApiSchema() { Type = "string", Format = "binary" } } } } } } } }; } } }
然后,在启动代码中配置,应用此操作筛选器:
builder.Services.AddSwaggerGen(setup => { setup.OperationFilter<FileUploadOperationFilter>(); });
这将呈现如下 Swagger 页面:
到此这篇关于使用最小 WEB API 实现文件上传的Swagger支持的文章就介绍到这了,更多相关使用最小 WEB API 实现文件上传 内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!
相关文章
Entity Framework使用Code First模式管理事务
本文详细讲解了Entity Framework使用Code First模式管理事务的方法,文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下2022-03-03基于.net4.0实现IdentityServer4客户端JWT解密
这篇文章主要为大家详细介绍了基于.net4.0实现IdentityServer4客户端JWT解密,具有一定的参考价值,感兴趣的小伙伴们可以参考一下2018-09-09使用ASP.NET一般处理程序或WebService返回JSON的实现代码
今天, 将为大家说明如何在 ASP.NET 中使用一般处理程序或者 WebService 向 javascript 返回 JSON2011-10-10asp.net XMLHttpRequest实现用户注册前的验证
用户注册前的验证,提高用户体验。2009-10-10EasyUI Tree+Asp.net实现权限树或目录树导航的简单实例
本篇文章主要是对EasyUI Tree+Asp.net实现权限树或目录树导航的简单实例进行了介绍,需要的朋友可以过来参考下,希望对大家有所帮助2014-02-02
最新评论