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

相关内容

热门资讯

揭秘真相!衢州都莱罗松怎么老是... 揭秘真相!衢州都莱罗松怎么老是输,多乐辅助app,透牌教程(有挂方法)-哔哩哔哩;衢州都莱罗松怎么老...
推荐十款!开心网辅助工具,乾坤... 推荐十款!开心网辅助工具,乾坤互娱辅助,必备教程(有挂猫腻)-哔哩哔哩;开心网辅助工具是一种具有地方...
今日焦点!天天卡五星辅助器,7... 今日焦点!天天卡五星辅助器,728游戏怎么控制的,切实教程(竟然有挂)-哔哩哔哩;致您一封信;亲爱天...
玩家攻略推荐!边锋小程序老友辅... 玩家攻略推荐!边锋小程序老友辅助,福建天天开心辅助工具,AI教程(今日头条)-哔哩哔哩;福建天天开心...
盘点一款!情怀游戏字牌辅助,葫... 盘点一款!情怀游戏字牌辅助,葫芦娃七子降妖攻略,解密教程(有挂辅助)-哔哩哔哩;葫芦娃七子降妖攻略软...
一分钟了解!财神十三章有哪些辅... 一分钟了解!财神十三章有哪些辅助功能,创思维激k看底牌辅助,安装教程(确实有挂)-哔哩哔哩;一、财神...
透视神器!小程序微乐辅助软件,... 透视神器!小程序微乐辅助软件,新鸿狐辅助软件是真的吗,详细教程(了解有挂)-哔哩哔哩;新鸿狐辅助软件...
透视玄学!兴动助手辅助器,好友... 透视玄学!兴动助手辅助器,好友赣南能装挂吗,靠谱教程(有挂实锤)-哔哩哔哩;详细好友赣南能装挂吗攻略...
透视挂!打大a开挂神器免费下载... 透视挂!打大a开挂神器免费下载,皮皮胡子辅助,透明挂教程(竟然有挂)-哔哩哔哩;小薇(透视辅助)致您...
发现一款!掌中乐游戏中心破解版... 发现一款!掌中乐游戏中心破解版,微乐家乡破解,实用技巧(有挂规律)-哔哩哔哩;1、不需要AI权限,帮...