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

相关内容

热门资讯

第8分钟了解!余干辅助软件哪个... 第8分钟了解!余干辅助软件哪个好!原来是真的有辅助插件(有挂总结)-哔哩哔哩1、上手简单,内置详细流...
第9分钟了解!牵手跑辅助!一贯... 第9分钟了解!牵手跑辅助!一贯真的是有辅助神器(有挂技巧)-哔哩哔哩1、牵手跑辅助辅助器安装包、牵手...
两分钟了解!浙江游戏温州熟客辅... 两分钟了解!浙江游戏温州熟客辅助!切实一直都是有辅助插件(果真有挂)-哔哩哔哩1、每一步都需要思考,...
第三分钟了解!海螺众娱脚本!真... 第三分钟了解!海螺众娱脚本!真是是真的有辅助教程(有挂解密)-哔哩哔哩1)海螺众娱脚本免费钻石:进一...
十分钟了解!决战血流辅助!一贯... 十分钟了解!决战血流辅助!一贯一直都是有辅助技巧(有挂详情)-哔哩哔哩运决战血流辅助辅助工具,进入游...
四分钟了解!开心泉州作必弊!果... 四分钟了解!开心泉州作必弊!果然存在有辅助技巧(有挂细节)-哔哩哔哩1、开心泉州作必弊透视辅助软件激...
三分钟了解!情怀麻烦将关春天辅... 三分钟了解!情怀麻烦将关春天辅助!其实一直总是有辅助神器(有挂教学)-哔哩哔哩1、完成情怀麻烦将关春...
8分钟了解!福建十三水软件开发... 8分钟了解!福建十三水软件开发!一直有辅助工具(有挂秘诀)-哔哩哔哩该软件可以轻松地帮助玩家将福建十...
九分钟了解!手游奇迹陕西辅助工... 九分钟了解!手游奇迹陕西辅助工具!果然一直都是有辅助方法(真实有挂)-哔哩哔哩该软件可以轻松地帮助玩...
第5分钟了解!微信海豚大厅辅助... 第5分钟了解!微信海豚大厅辅助!总是一直总是有辅助软件(证实有挂)-哔哩哔哩该软件可以轻松地帮助玩家...