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

相关内容

热门资讯

透视了解!德普之星辅助功能如何... 透视了解!德普之星辅助功能如何设置,四川游戏家园通用辅助,分享教程(有挂攻略);建议优先通过四川游戏...
透视透视!wepoker透视脚... 透视透视!wepoker透视脚本安卓,多乐小程序游戏辅助器,攻略教程(有挂攻略)1、玩家可以在多乐小...
透视插件!智星菠萝辅助怎么买,... 透视插件!智星菠萝辅助怎么买,wepoker辅助器免费,安装教程(有挂透视);亲真的是有正版授权,小...
透视新版!智星德州菠萝插件官网... 透视新版!智星德州菠萝插件官网,闲聚app辅助软件,必胜教程(有挂教程)1、很好的工具软件,可以解锁...
透视总结!wpk辅助插件叫什么... 透视总结!wpk辅助插件叫什么,闲逸辅助软件下载,可靠教程(有挂方法);建议优先通过闲逸辅助软件下载...
透视科技!wpk辅助软件多少钱... 透视科技!wpk辅助软件多少钱一个,好友赣南插件,必胜教程(有挂透视)1、很好的工具软件,可以解锁游...
透视工具!hhpoker透视脚... 透视工具!hhpoker透视脚本安卓,唯思竞技修改器,大神讲解(有挂透视)1、很好的工具软件,可以解...
透视软件!aapoker透视脚... 透视软件!aapoker透视脚本下载,创思维激k辅助控制器,必赢方法(有挂攻略)这是由厦门游乐互动科...
透视免费!德普之星辅助器,微乐... 透视免费!德普之星辅助器,微乐陕西三代自建房挂,安装教程(有挂方法);科技安装教程;13670430...
透视私人局!aapoker透视... 透视私人局!aapoker透视软件,皮皮跑胡子有没有挂,扑克教程(有挂透视);致您一封信;亲爱皮皮跑...