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

相关内容

热门资讯

大家学习交流!wepoker透... 大家学习交流!wepoker透视苹果系统,德普之星辅助工具如何设置,好像是有挂(有挂详细)运辅助工具...
安装程序教程!wepokerp... 安装程序教程!wepokerplus万能挂,wpk透视插件,切实是真的有挂(有挂分析)1、玩家可以在...
推荐十款!wepoker如何设... 推荐十款!wepoker如何设置透视,wepoker智能辅助插件,竟然是真的有挂(有挂助手)1、we...
推荐十款!wepoker手机版... 推荐十款!wepoker手机版透视脚本,wepoker游戏下载,好像存在有挂(有挂秘笈)1、操作简单...
一分钟了解!德州透视插件,we... 一分钟了解!德州透视插件,wepoker私人局辅助器怎么用,切实是真的有挂(确实有挂)暗藏猫腻,小编...
推荐一款!德普之星透视辅助,w... 推荐一款!德普之星透视辅助,wepoker软件靠谱么,果然有挂(有挂方法)1、这是跨平台的轻量版有透...
发现一款!wepoker有没有... 发现一款!wepoker有没有透视方法,扑克之星辅助,其实是有挂(有挂教程)1、任何透视是真的假的的...
重大推荐!德州透视插件,pok... 重大推荐!德州透视插件,pokemmo手机版脚本,一贯真的有挂(新版有挂)1、用户打开应用后不用登录...
玩家交流!wepoker轻量版... 玩家交流!wepoker轻量版辅助,wepoker软件辅助程序,果然真的有挂(详细教程)1. 选牌创...
玩家攻略推荐!pokemmo手... 玩家攻略推荐!pokemmo手机辅助软件,hhpoker底牌透视脚本,真是真的是有挂(有挂教程)一、...