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文档时,拆分的数组对象将会显示出来。

相关内容

热门资讯

玩家必备科普透视挂!wepok... 一款 AI 游戏攻略黑科技工具上线,查攻略效率直接开挂。它整合版本更新、装备搭配、BOSS 打法、牌...
玩家必看科普开挂!之星私人局辅... 很多人使用云端 AI 时,都担心之星私人局辅助器、内部资料上传带来隐私风险。这款本地运行的 AI 黑...
玩家必用辅助挂!WPK透视版,... 玩家必用辅助挂!WPK透视版,WPK透视辅助安装(果然真的有辅助挂)AI 智能体黑科技再上新,自动化...
玩家爆料透视挂!wepoker... 『标题:当前标题』主打赛后复盘的 AI 游戏攻略黑科技走红,对局总结能力开挂。上传对局回放或者战绩截...
教你攻略辅助挂!德普之星透视辅... 德普之星透视辅助iosAI 游戏攻略黑科技上线本地缓存功能,离线查阅能力开挂。提前下载对应游戏攻略数...
实测揭晓!透视!wepoker... wepoker能不能透视AI 游戏攻略黑科技上线本地缓存功能,离线查阅能力开挂。提前下载对应游戏攻略...
来一盘透视!wepoker模拟... 您好:wepoker模拟器哪个这款游戏可以开挂的,确实是有挂的,很多玩家在这款游戏中打牌都会发现很多...
今日公布透视挂!wepoker... 今日公布透视挂!wepoker开脚本视频,微扑克辅助软件助手(素来真的有透视挂)AI 是一款可以让一...
玩家亲测透视!智星菠萝有挂吗,... AI 黑科技赛道又上新,这款智能处理工具堪称效率开挂,专门面向短视频创作者打造。它打通脚本撰写、AI...
分享个大家透视!wpk辅助器是... 很多人使用云端 AI 时,都担心wpk辅助器是真的吗、内部资料上传带来隐私风险。这款本地运行的 AI...