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、进入到德扑起手牌胜率...
德州之星外 挂!德州辅助神器w... 德州之星外 挂!德州辅助神器wpk,poker master安卓版外 挂(详细透视辅助神器技巧)1、...
德扑ai智能机器人!德扑之星作... 德扑ai智能机器人!德扑之星作弊,德扑之星确实真的有挂(详细透视辅助器教程)1、超多福利:超高返利,...
德州之星有外 挂!GG扑克辅助... 您好,gg扑克发牌这款游戏可以开挂的,确实是有挂的,需要了解加微【757446909】很多玩家在这款...
德扑之星有作弊!德扑数据软件,... 德扑之星有作弊!德扑数据软件,德扑之星总是真的有挂(详细透视辅助app教程)德扑之星有作弊软件透明挂...
德州之星有外 挂!德州辅助,轰... 德州之星有外 挂!德州辅助,轰趴大菠萝十三水辅助(详细透视辅助插件脚本);1、完成轰趴大菠萝十三水辅...
德扑之星辅助器购买!德扑之星可... 德扑之星辅助器购买!德扑之星可以设置埋牌,德扑ai原来真的有挂(详细透视辅助器教程);1、进入游戏-...
德州ai辅助有用!德州ai机器... 德州ai辅助有用!德州ai机器人免费测试,poker软件免费(详细透视辅助插件脚本)1、poker软...
德扑ai智能机器人!德扑ai决... 德扑ai智能机器人!德扑ai决策软件,德扑平台都是真的有挂(详细透视辅助脚本教程)1、德扑ai智能机...
德州ai人工智能!德州免费辅助... 德州ai人工智能!德州免费辅助神器app,欢乐棋牌有挂(详细透视辅助挂揭秘)欢乐棋牌有挂是一种具有地...