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及以上可用的。如果你使用的是旧版本,请查阅相应的文档或升级到最新版本。

相关内容

热门资讯

透视真的(wpk俱乐部)aap... 透视真的(wpk俱乐部)aapoker有网页版吗(详细辅助玩家教你)最初是真的有挂;辅助插件是一个在...
透视好友(微扑克ai辅助)轰趴... 透视好友(微扑克ai辅助)轰趴大菠萝怎么提高胜率(详细辅助细节揭秘)起初真的有挂,亲,有的,ai轻松...
微扑克有辅助挂!aapoker... 微扑克有辅助挂!aapoker辅助,(AAPOKeR)起初真的有挂(详细辅助黑科技教程);原来确实真...
透视教程(微扑克ai辅助工具)... 透视教程(微扑克ai辅助工具)德扑之星隐藏功能(详细辅助透明挂教程)固有真的是有挂;一、AI软件牌型...
aapoker猫腻!wpk微扑... 《aapoker猫腻软件透明挂》是一款多人竞技的aapoker猫腻辅助透视游戏,你将微扑克对手来到同...
微扑克辅助软件!鱼扑克app ... 微扑克辅助软件!鱼扑克app ai,(wepokE)一贯存在有挂(详细辅助攻略教程);支持2-10人...
透视辅助(德州微扑克辅助)欢乐... 透视辅助(德州微扑克辅助)欢乐棋牌有没有挂(详细辅助新版2025教程)往昔真的有挂;是一种具有地方特...
透视游戏(德扑之星ai代打)g... 您好,这款游戏可以开挂的,确实是有挂的,需要了解加Q群【1067239143】很多玩家在这款游戏中打...
德扑ai智能机器人!cloud... 德扑ai智能机器人!cloudpoker云扑克,(AAPOKeR)确实是真的有挂(详细辅助爆料教程)...
透视软件(aapoker外挂)... 透视软件(aapoker外挂)菠萝德州偷偷看功能(详细辅助必备教程)都是是真的有挂;无聊就玩这款真的...