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

相关内容

热门资讯

实操分享辅助挂!we-poke... 本地部署 AI 黑科技工具迎来新版本,不用上传文件到云端就能完成we-poker辅助解析、 AI 处...
热门推荐透视!we poker... 一款 AI 游戏攻略黑科技工具上线,查攻略效率直接开挂。它整合版本更新、装备搭配、BOSS 打法、牌...
玩家交流透视挂!wpk透视是真... AI 黑科技赛道又上新,这款智能处理工具堪称效率开挂,专门面向短视频创作者打造。它打通脚本撰写、AI...
AI教程辅助!wepoker有... AI教程辅助!wepoker有透视底牌吗,微扑克开挂技巧插件(往昔是真的有辅助)主打本地运行的 AI...
最新技巧!辅助挂!WPK购买,... 最新技巧!辅助挂!WPK购买,WPK可以开挂吗安装(确实真的是有辅助挂)AI 是一款可以让一直输的玩...
今日焦点透视挂!wpk德州局怎... 一款 AI 游戏攻略黑科技工具上线,查攻略效率直接开挂。它整合版本更新、装备搭配、BOSS 打法、牌...
2分钟细说透视挂!wepoke... 您好,2分钟细说透视挂!wepoker底牌透视,德扑之星怎么开挂工具(素来真的是有透视挂)这款游戏可...
玩家必备教程透视挂!WPK工具... 玩家必备教程透视挂!WPK工具,WPK可以装挂吗插件(从来有透视挂)主打本地运行的 AI 黑科技工具...
热点推荐辅助!wejoker辅... wejoker辅助软件AI 游戏攻略黑科技上线本地缓存功能,离线查阅能力开挂。提前下载对应游戏攻略数...
盘点一款辅助器!微扑克游戏辅助... 微扑克游戏辅助器AI 游戏攻略黑科技上线本地缓存功能,离线查阅能力开挂。提前下载对应游戏攻略数据包,...