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

相关内容

热门资讯

两分钟了解!牌乐门怎么玩包赢,... 两分钟了解!牌乐门怎么玩包赢,德州ai辅助神器可以收费(详细透视辅助黑科技教程);建议优先通过牌乐门...
两分钟了解!拱趴游戏辅助器,红... 两分钟了解!拱趴游戏辅助器,红龙扑克ai(详细透视辅助助手教程);亲们利用一分钟了解精致的软件效果,...
2分钟教学!微信开心十三张辅助... 2分钟教学!微信开心十三张辅助是真是假,德扑网上设置(详细透视辅助工具教程)关于微信开心十三张辅助是...
九分钟攻略!17麻将大菠萝胜率... 九分钟攻略!17麻将大菠萝胜率规律,wopoker真的有挂(详细透视辅助黑科技教程);(需添加指定薇...
五分钟介绍!皮皮四川麻将有挂没... 1、五分钟介绍!皮皮四川麻将有挂没有,poker软件免费(详细透视辅助app教程)。2、皮皮四川麻将...
四分钟教程!奈曼麻将有挂吗,w... 四分钟教程!奈曼麻将有挂吗,wpk微扑克辅助透视(详细透视辅助助手教程)1、每一步都需要思考,不同水...
9分钟技巧!欢乐情怀软件使用方... 9分钟技巧!欢乐情怀软件使用方法,红龙扑克辅助工具(详细透视辅助神器教程);科技安装教程;13670...
一分钟详情!jj斗地主透视神器... 1、一分钟详情!jj斗地主透视神器,德扑网上设置(详细透视辅助挂教程)2、进入游戏-大厅左侧-新手福...
一分钟详情!阳光岛牌乐汇辅助工... 一分钟详情!阳光岛牌乐汇辅助工具,云扑克有辅助软件(详细透视辅助工具教程)阳光岛牌乐汇辅助工具平台为...
5分钟规律!开心联盟牛牛怎样胜... 5分钟规律!开心联盟牛牛怎样胜率高,cloud辅助(详细透视辅助挂教程)相信很多朋友都在电脑上玩过开...