需要将现有模型(非内联)添加到中的Swagger模式。网络核心API

Question

我正在为我的. Net core 6基于API生成Swagger文档。我有一些错误模型将由我的Gateway返回。这些在我的任何APIendpoint中都没有使用/返回。我想将这些模型添加到Swagger文档架构集合中。如果我遵循内联方式，我能够成功添加它们。有没有办法将现有模型包含在Swagger架构集合中？

我还想将网络钩子模型和示例包含到架构集合中，而无需通过内联选项。

谢谢你的时间。

Answer 1

您可以执行以下操作将模型添加到架构集合中。

创建自定义文档过滤器

public class CustomDocumentFilter : IDocumentFilter
{
    public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
    {
        context.SchemaGenerator.GenerateSchema(typeof(GWErrorModel), context.SchemaRepository);
    }
}

将其添加到程序中.cs

   builder.Services.AddSwaggerGen(o =>
   {
      o.DocumentFilter<CustomDocumentFilter>();
   });

您将看到模型被添加到架构集合中。

希望有帮助。