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

相关内容

热门资讯

每日必看教程开挂攻略!指尖四川... 每日必看教程开挂攻略!指尖四川麻将多功能开挂攻略,指尖四川麻将切实真的是有开挂攻略1、指尖四川麻将辅...
实测必看作弊器技巧!梦黄麻将多... 实测必看作弊器技巧!梦黄麻将多功能作弊器技巧,梦黄麻将果然存在有作弊器技巧1、梦黄麻将免费脚本咨询教...
研究成果辅助器教程!小白大作战... 研究成果辅助器教程!小白大作战多功能辅助器教程,小白大作战确实真的有辅助器教程所有人都在同一条线上,...
分享认知辅助软件!小闲巴渝棋牌... 分享认知辅助软件!小闲巴渝棋牌多功能辅助软件,小闲巴渝棋牌竟然是有辅助软件1、不需要AI权限,帮助你...
分享认知透视器app!温岭逸趣... 分享认知透视器app!温岭逸趣麻将多功能透视器app,温岭逸趣麻将真是是有透视器app1)温岭逸趣麻...
专业讨论作弊器插件!欢乐划水麻... 专业讨论作弊器插件!欢乐划水麻将多功能作弊器插件,欢乐划水麻将果然真的是有作弊器插件1、用户打开应用...
最新技巧外挂攻略!逍遥皖北棋牌... 最新技巧外挂攻略!逍遥皖北棋牌多功能外挂攻略,逍遥皖北棋牌都是存在有外挂攻略亲,关键说明,逍遥皖北棋...
今日公布辅助app!乐通多功能... 今日公布辅助app!乐通多功能辅助app,乐通一直有辅助app1、乐通破解器简单,乐通机器人操作,乐...
揭秘一下辅助攻略!青橙竞技多功... 揭秘一下辅助攻略!青橙竞技多功能辅助攻略,青橙竞技一贯真的是有辅助攻略1、玩家可以在青橙竞技线上大神...
推荐一款透视挂技巧!无锡麻将多... 推荐一款透视挂技巧!无锡麻将多功能透视挂技巧,无锡麻将原来有透视挂技巧1、起透看视 无锡麻将辅助软件...