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、第九分钟了解!微信开发...
5分钟了解!潮汕雀友百度贴吧辅... 5分钟了解!潮汕雀友百度贴吧辅助软件!一贯是有辅助方法(有挂透视)-哔哩哔哩一、潮汕雀友百度贴吧辅助...
8分钟了解!财神十三章辅助官网... 8分钟了解!财神十三章辅助官网入口!总是存在有辅助app(真的有挂)-哔哩哔哩1.财神十三章辅助官网...
第八分钟了解!wepoker安... 第八分钟了解!wepoker安装教程!竟然真的是有辅助神器(有挂秘籍)-哔哩哔哩1、首先打开wepo...
第十分钟了解!上饶中至辅助插件... 第十分钟了解!上饶中至辅助插件透视!果然是真的有辅助软件(有挂秘籍)-哔哩哔哩1、这是跨平台的上饶中...
第七分钟了解!悟空大厅辅助器下... 第七分钟了解!悟空大厅辅助器下载!切实真的有辅助技巧(有挂规律)-哔哩哔哩1、玩家可以在悟空大厅辅助...
7分钟了解!指尖四川辅助脚本苹... 7分钟了解!指尖四川辅助脚本苹果版!切实是真的有辅助脚本(有挂猫腻)-哔哩哔哩指尖四川辅助脚本苹果版...
7分钟了解!一起宁德钓蟹作弊!... 7分钟了解!一起宁德钓蟹作弊!一直是有辅助脚本(竟然有挂)-哔哩哔哩1、在一起宁德钓蟹作弊插件功能辅...
九分钟了解!樱花之盛正版辅助器... 九分钟了解!樱花之盛正版辅助器免费!本来真的有辅助神器(确实有挂)-哔哩哔哩1、点击下载安装,樱花之...
第8分钟了解!情怀宜春辅助!一... 第8分钟了解!情怀宜春辅助!一贯是有辅助app(揭秘有挂)-哔哩哔哩1、情怀宜春辅助破解器简单,情怀...