ASP.NET Core Web API和Swagger:即使字段不是必需的,也会出现IFormFile的必需字段错误。
创始人
2024-09-15 14:00:26
0

在ASP.NET Core Web API中,如果需要上传文件,可以使用IFormFile类型来接收文件。通常情况下,如果使用Swagger来自动生成API文档,会根据参数的IsRequired属性来判断是否为必需字段。然而,当使用IFormFile类型时,即使字段不是必需的,Swagger也会将其视为必需字段并显示错误。

要解决这个问题,可以使用自定义的OperationFilter来修改Swagger生成的文档,将IFormFile字段标记为非必需字段。

首先,创建一个名为OptionalFileOperationFilter的类,并实现IOperationFilter接口,如下所示:

using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerGen;

public class OptionalFileOperationFilter : IOperationFilter
{
    public void Apply(OpenApiOperation operation, OperationFilterContext context)
    {
        foreach (var parameter in operation.Parameters)
        {
            var fileAttribute = parameter.Attributes().OfType().FirstOrDefault();
            if (fileAttribute != null)
            {
                parameter.Required = false;
            }
        }
    }
}

然后,在Startup.cs文件的ConfigureServices方法中注册该OperationFilter,如下所示:

services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
    c.OperationFilter(); // 注册自定义的OperationFilter
});

这样做之后,Swagger将不再将IFormFile字段标记为必需字段,并且不会显示错误。

希望以上解决方法对你有帮助!

相关内容

热门资讯

有挂神器开挂!雀友会鱼虾蟹下载... 有挂神器开挂!雀友会鱼虾蟹下载官网辅助器,wepoker辅助器软件下载(分享认知开挂辅助安装)您好:...
有挂详细辅助!小程序能不能开挂... >>您好:小程序能不能开挂确实是有挂的,很多玩家在这款小程序能不能开挂游戏中打牌都会发现很多用户的牌...
有挂规律开挂!乐乐游戏辅助器,... 有挂规律开挂!乐乐游戏辅助器,丰县14张脚本(透视了解开挂辅助平台);无需打开直接搜索加(薇:136...
竟然有挂开挂!天天爱柳州麻将辅... 竟然有挂开挂!天天爱柳州麻将辅助器,奇迹陕西辅助(六分钟了解开挂辅助安装) 【无需打开直接搜索加薇1...
有挂规律开挂!闲逸辅助器,微友... 有挂规律开挂!闲逸辅助器,微友辅助器免费版(新手必备开挂辅助软件) >>您好:软件加薇1367043...
确实有挂辅助!丰城双剑辅助,新... 确实有挂辅助!丰城双剑辅助,新九哥开挂(每日必备开挂辅助下载) >>您好:软件加薇136704302...
有挂工具开挂!杭州都莱大菠萝辅... 有挂工具开挂!杭州都莱大菠萝辅助器,微友助手破解版(透视私人局开挂辅助平台) 了解更多开挂安装加(1...
真的有挂开挂!海贝之城正版辅助... 真的有挂开挂!海贝之城正版辅助,哥哥打大a有辅助吗(2分钟细说开挂辅助平台)哥哥打大a有辅助吗ai黑...
有挂方针开挂!潘潘讲故事辅助器... 有挂方针开挂!潘潘讲故事辅助器,人海大厅辅助插件(玩家必备教程开挂辅助插件);是一款可以让一直输的玩...
有挂教程辅助!威信茶馆修改器,... 有挂教程辅助!威信茶馆修改器,wpk辅助最怕三个东西(六分钟了解开挂辅助神器)威信茶馆修改器ai黑科...