ASP.Net Core Swagger如何忽略默认参数值
创始人
2024-09-15 12:30:26
0

在ASP.Net Core Swagger中,可以使用SwaggerGenOptions类的DefaultIgnoreAttributeFilter属性来忽略默认参数值。下面是一个代码示例:

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerGen;

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddControllers();

        services.AddSwaggerGen(c =>
        {
            c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });

            c.DefaultIgnoreAttributeFilter();

            // 可选步骤:忽略特定的默认参数值
            //c.OperationFilter();
        });
    }

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }

        app.UseRouting();

        app.UseSwagger();
        app.UseSwaggerUI(c =>
        {
            c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
        });

        app.UseEndpoints(endpoints =>
        {
            endpoints.MapControllers();
        });
    }
}

// 可选步骤:自定义操作过滤器以忽略特定的默认参数值
public class IgnoreDefaultValueOperationFilter : IOperationFilter
{
    public void Apply(OpenApiOperation operation, OperationFilterContext context)
    {
        foreach (var parameter in operation.Parameters)
        {
            var parameterInfo = context.ApiDescription.ParameterDescriptions.FirstOrDefault(p => p.Name == parameter.Name);
            if (parameterInfo != null && parameterInfo.DefaultValue != null)
            {
                parameter.Default = OpenApiAnyFactory.CreateFor(parameter.Schema, parameterInfo.DefaultValue);
            }
        }
    }
}

上述代码中,DefaultIgnoreAttributeFilter方法用于忽略所有默认参数值,如果你只想忽略特定的默认参数值,可以使用IgnoreDefaultValueOperationFilter自定义操作过滤器,并在ConfigureServices方法中注册该过滤器。

注意:DefaultIgnoreAttributeFilter方法是在Swashbuckle.AspNetCore版本5.0.0及以上可用的。如果你使用的是旧版本,请查阅相应的文档或升级到最新版本。

相关内容

热门资讯

第十分钟辅助!顺欣茶楼辅助软件... 第十分钟辅助!顺欣茶楼辅助软件,上品游戏辅助软件(一分钟了解开挂辅助工具);1、超多福利:超高返利,...
1分钟辅助!潮汕汇鱼虾蟹辅助,... 1分钟辅助!潮汕汇鱼虾蟹辅助,潮友潮汕木虱辅助(透视教程开挂辅助下载);潮友潮汕木虱辅助免费下载原版...
第9分钟辅助!蘑菇云辅助怎么使... 第9分钟辅助!蘑菇云辅助怎么使用,微信呢小程序微乐房间怎么开挂(我来分享开挂辅助工具);大家肯定在之...
第七分钟辅助!wepoker辅... 【福星临门,好运相随】;第七分钟辅助!wepoker辅助器是真的吗,闲逸斗地主辅助(透视app开挂辅...
八分钟辅助!智星菠萝可以辅助吗... 【福星临门,好运相随】;八分钟辅助!智星菠萝可以辅助吗,新道游开挂辅助透视(重大通报开挂辅助神器);...
辅助开挂!四川游戏家园辅助软件... 辅助开挂!四川游戏家园辅助软件,hhpkoer辅助器(透视)开挂辅助软件(有人有挂);1、不需要AI...
辅助开挂!博雅红河西元红河破解... 辅助开挂!博雅红河西元红河破解版,德州透视是真的吗(透视)开挂辅助平台(新版有挂);博雅红河西元红河...
开挂辅助!好友赣南新版本可以作... 开挂辅助!好友赣南新版本可以作假吗,hhpoker免费透视脚本(透视)开挂辅助神器(讲解有挂);小薇...
开挂辅助!微乐小程序辅助,德州... 开挂辅助!微乐小程序辅助,德州局hhpoker(透视)开挂辅助工具(有挂辅助);1、让任何用户在无需...
开挂辅助!雀友会潮汕麻将开挂辅... 开挂辅助!雀友会潮汕麻将开挂辅助,wepoker永久免费脚本(透视)开挂辅助软件(的确有挂);1、很...