ASP.net Core中,Swagger不显示拆分的数组对象
创始人
2024-11-12 04:30:08
0

在ASP.NET Core中,Swagger默认不会显示拆分的数组对象,但可以通过自定义Swagger的SchemaFilter来解决这个问题。

下面是一个示例的解决方法。

首先,创建一个自定义的SchemaFilter类,例如SplitArrayObjectSchemaFilter:

using System;
using System.Linq;
using System.Reflection;
using Microsoft.OpenApi.Any;
using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerGen;

public class SplitArrayObjectSchemaFilter : ISchemaFilter
{
    public void Apply(OpenApiSchema schema, SchemaFilterContext context)
    {
        var propertiesToRemove = schema.Properties
            .Where(p => p.Value.Type == "array" && p.Value.Items.Type == "object")
            .Select(p => p.Key)
            .ToList();

        foreach (var propertyToRemove in propertiesToRemove)
        {
            schema.Properties.Remove(propertyToRemove);
            var splitProperties = context.Type.GetProperties(BindingFlags.Public | BindingFlags.Instance)
                .Where(p => p.Name.StartsWith(propertyToRemove + "[") && p.PropertyType.IsClass && p.PropertyType != typeof(string))
                .ToList();

            foreach (var splitProperty in splitProperties)
            {
                var splitPropertySchema = context.SchemaGenerator.GenerateSchema(splitProperty.PropertyType, context.SchemaRepository);
                schema.Properties.Add(splitProperty.Name, splitPropertySchema);
            }
        }
    }
}

然后,在Startup.cs文件中的ConfigureServices方法中注册该SchemaFilter:

public void ConfigureServices(IServiceCollection services)
{
    // ...

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

    // ...
}

这样,在使用Swagger生成API文档时,拆分的数组对象将会显示出来。

相关内容

热门资讯

玩家爆料!广东闲来辅助神器免费... 您好,广东闲来辅助神器免费版这款游戏可以开挂的,确实是有挂的,需要了解加去威信【136704302】...
玩家必看科普!三哥玩摆头可以控... 玩家必看科普!三哥玩摆头可以控制,德友汇辅助器,详细器(有挂猫腻)1、三哥玩摆头可以控制透视辅助软件...
一分钟揭秘!潮友会鱼虾蟹有没有... 一分钟揭秘!潮友会鱼虾蟹有没有挂辅助,柳州天天爱字牌辅助器,详细器(有挂教程)1、实时潮友会鱼虾蟹有...
发现玩家!朋朋政和辅助,闲逸辅... 发现玩家!朋朋政和辅助,闲逸辅助器下载,详细app(有挂秘笈)1、玩家可以在闲逸辅助器下载线上大神俱...
玩家爆料!四川长牌皮皮游戏挂,... 玩家爆料!四川长牌皮皮游戏挂,微信牵手跑辅助,详细方法(真是有挂)该软件可以轻松地帮助玩家将四川长牌...
研究成果!牵手跑得软件,大咖娱... 研究成果!牵手跑得软件,大咖娱乐挂脚本,详细教程(有挂方法)一、大咖娱乐挂脚本游戏安装教程牌型概率发...
必知教程!微友圈app辅助工具... 必知教程!微友圈app辅助工具,微信小程序挂件辅助,详细脚本(讲解有挂)微信小程序挂件辅助破解侠是真...
实测分享!潮汕鱼虾蟹app源码... 实测分享!潮汕鱼虾蟹app源码,开心泉州小程序辅助免费下载,详细器(有挂透视)开心泉州小程序辅助免费...
今日头条!光明大厅透视辅助,天... 今日头条!光明大厅透视辅助,天天透视辅助工具,详细插件(有挂详细)1、许多玩家不知道天天透视辅助工具...
盘点一款!扣点点脚本辅助器,乐... 盘点一款!扣点点脚本辅助器,乐酷副厅外挂,详细工具(有挂方法)扣点点脚本辅助器是不是有人用挂微扑克w...