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、很...
必备攻略!微乐小程序黑科技免费... 必备攻略!微乐小程序黑科技免费工具,微乐辅助工具哪个好用-确实是有辅助脚本(有挂教程)1、微乐小程序...
玩家科普!微乐小程序家乡自建房... 玩家科普!微乐小程序家乡自建房辅助app,微乐河南小程序微乐辅助脚本-总是有辅助工具(果真有挂)1、...
一分钟了解!微乐家乡麻将辅助,... 一分钟了解!微乐家乡麻将辅助,微乐家乡app下载-好像存在有辅助软件(有挂教程)进入游戏-大厅左侧-...
必知教程!微信微乐小程序辅助器... 必知教程!微信微乐小程序辅助器免费安装,广西微乐小程序脚本-其实真的有辅助教程(有挂规律)微信微乐小...
玩家必看分享!微信小程序微乐辅... 玩家必看分享!微信小程序微乐辅助器教程,微乐自建房免费脚本哪个最好用-确实是真的有辅助脚本(有挂助手...
科普分享!小程序微乐游戏辅助器... 科普分享!小程序微乐游戏辅助器,微乐广西麻辣辅助-果然有辅助神器(有挂头条)1、起透看视 小程序微乐...
查到实测!微信微乐小程序修改器... 查到实测!微信微乐小程序修改器,微乐自建房怎么提高运气-真是是真的有辅助器(了解有挂)1、首先打开微...
记者揭秘!微乐小程序微乐辅助软... 记者揭秘!微乐小程序微乐辅助软件,微乐小程序辅助脚本平台-一贯有辅助器(新版有挂)1、微乐小程序微乐...