swashbuckle生成内部C＃类的模式

Question

使用swashbuckle.aspnetcore（版本6.3.1）与system.text.json时，该架构会从c＃中生成一堆内部设备，例如incoper> assembly 的架构> constructorInfo等。

我认为，当我创建一个返回接口（可能）的端点时，就会发生这种情况。不完全确定。如果我利用swashbuckle.aspnetcore.newtonsoft软件包来生成宣传文档，那不是问题 - 这些模式未生成。但是，我希望不依赖纽顿夫妇，这是获得有效模式的唯一原因。

这不是一个大问题，但是我们的OpenAPI/Swagger文档有无关紧要的信息有点烦人。我很想解决这个问题。

这是一个已知的错误吗？有办法解决吗？任何帮助都将不胜感激。

我试图搜索问题的不同组合，但没有成功。我的查询技巧我很糟糕，所以如果已经问这个问题，那我真的很抱歉。

编辑： 该错误似乎是由于我们有一个具有自定义序列化器在API中公开的值类型。该对象具有type属性，但是，由于序列化器，这实际上从未在API中曝光 - （我们也向Swashbuckle注册，因此实际上并未在Swashbuckle文档中曝光，但是，我认为Swashbuckle在我们注册“正确”序列化器之前已经将对象添加到模式中。）

Answer 1

删除它的一种方法是通过iDocumentFilter这样：

    public class RemoveSchemasFilter : IDocumentFilter
    {
        public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
        {
            var types = (Assembly.GetAssembly(this.GetType())).GetTypes().Where(x => x.IsClass).Select(x => x.Name);

            IDictionary<string, OpenApiSchema> _remove = swaggerDoc.Components.Schemas.Where(x => !types.Contains(x.Key)).ToDictionary(x => x.Key, x => x.Value);
            foreach (KeyValuePair<string, OpenApiSchema> _item in _remove)
            {
                swaggerDoc.Components.Schemas.Remove(_item.Key);
            }
        }
    }

在您的di中，您注册Swagger只需添加此信息

builder.Services.AddSwaggerGen(c => c.DocumentFilter<RemoveSchemasFilter>())

Answer 2

我偶然发现了这个问题，因为我遇到了同样的问题。就我而言，该问题是通过指定filenotfoundexception为wessioneType ：

[ProducesResponseType(typeof(FileNotFoundException), StatusCodes.Status404NotFound)]

在我创建自己的filenotfoundresponse class之后，

public class DocumentNotFoundResponse
{
    public required string Message { get; init; }
    public required string FileName { get; init; }
}

并将其指定为<代码>响应类型，内部.NET类不再显示为架构：

[ProducesResponseType(typeof(DocumentNotFoundResponse), StatusCodes.Status404NotFound)]

这种行为可能在其他内部类型中也发生。但是，我尚未对此进行测试。

因此，我不知道它是否解决了OP的问题，但也许会对某人有所帮助。