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

相关内容

热门资讯

普及透视!hardrock作必... 普及透视!hardrock作必弊!原来存在有辅助插件(有挂技术)-哔哩哔哩一、hardrock作必弊...
有挂透视!sohoo poke... 有挂透视!sohoo poker辅助!果然存在有辅助app(有挂技巧)-哔哩哔哩1、打开软件启动之后...
详情透视!来玩德州破解器!总是... 详情透视!来玩德州破解器!总是有辅助神器(发现有挂)-哔哩哔哩1、来玩德州破解器免费辅助多个强度级别...
揭露透视!哈糖大菠萝可以开挂吗... 揭露透视!哈糖大菠萝可以开挂吗!都是是有辅助工具(有挂实锤)-哔哩哔哩1、上手简单,内置详细流程视频...
教你透视!佛手大菠萝13道挂哪... 教你透视!佛手大菠萝13道挂哪里!真是真的有辅助攻略(详细教程)-哔哩哔哩佛手大菠萝13道挂哪里透视...
关于透视!xpoker辅助控制... 关于透视!xpoker辅助控制!好像是有辅助教程(有挂秘籍)-哔哩哔哩1、许多玩家不知道xpoker...
总结透视!红龙poker作必弊... 总结透视!红龙poker作必弊指令!好像是有辅助app(有人有挂)-哔哩哔哩1)红龙poker作必弊...
了解透视!德州机器人代打脚本!... 了解透视!德州机器人代打脚本!真是真的是有辅助工具(有挂总结)-哔哩哔哩1、实时德州机器人代打脚本透...
了解透视!poker mast... 了解透视!poker master辅助!原来一直都是有辅助方法(有挂解惑)-哔哩哔哩1、poker ...
普及透视!xpoker辅助器!... 普及透视!xpoker辅助器!切实是有辅助技巧(的确有挂)-哔哩哔哩1、该软件可以轻松地帮助玩家将x...