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)大唐麻雀辅助器怎么设置免费钻石...
据目击者称!新道游app辅助器... 据目击者称!新道游app辅助器!原来是有辅助修改器(真的有挂)-哔哩哔哩新道游app辅助器是不是有人...
现有关情况通报如下!开心网辅助... 现有关情况通报如下!开心网辅助工具!真是存在有辅助平台(有挂工具)-哔哩哔哩;暗藏猫腻,小编详细说明...
出乎意料的是!上饶辅助!好像是... 出乎意料的是!上饶辅助!好像是有辅助修改器(有挂方法)-哔哩哔哩1、上饶辅助破解器简单,上饶辅助机器...
据相关数据显示!广西友乐app... 据相关数据显示!广西友乐app辅助工具!确实存在有辅助器(有挂攻略)-哔哩哔哩1、游戏颠覆性的策略玩...
今天上午!新上游通用挂!原来真... 今天上午!新上游通用挂!原来真的有辅助平台(有挂总结)-哔哩哔哩;一、新上游通用挂游戏安装教程牌型概...
有了最新消息!大唐山西辅助软件... 有了最新消息!大唐山西辅助软件!其实存在有辅助工具(有挂详情)-哔哩哔哩1、大唐山西辅助软件免费脚本...
值得注意的是!微乐贵阳捉鸡麻将... 值得注意的是!微乐贵阳捉鸡麻将开挂!其实真的是有辅助神器(有挂技巧)-哔哩哔哩1、玩家可以在微乐贵阳...
据报道!广东雀神智能插件安装软... 据报道!广东雀神智能插件安装软件!总是是真的辅助工具(有挂猫腻)-哔哩哔哩1、游戏颠覆性的策略玩法,...