对于大型架构，Swashbuckle 非常慢

Question

我有一个包含 90 多个表的数据库，这些表都通过外键相互交叉链接。

当我打开我的 API 的 swagger 页面时，加载需要 2 多分钟。原因似乎是它为每个 API 生成 Model 和 Example Value。由于交叉链接，几乎每个实体都引用了所有其他实体（通过递归传递闭包）！

当swagger生成Model和Example Value时，有没有办法禁用或限制递归？

例如，

class A {
   int id;
   List<B> Blist;
}

class B {
   int id;
   List<C> Clist;
}

class C {
   int id;
   List<D> Dlist;
}

/// etc...

如果我有一个用于GET /api/A 的 API，那么我不想将所有类都拉到 swagger 页面 Model 中。太大了！！我只想拉A。

Answer 1

你的问题的答案很简短

swagger生成Model和Example时有什么办法限制递归？

很遗憾没有！

目前没有这样的选择。但这是可能的，我们正在讨论它：
https://github.com/swagger-api/swagger-ui/issues/4411
在此处添加评论并 +1 该问题，让团队知道这对您很重要。

Swagger-UI 不能很好地处理复杂的模式，有时只是速度很慢，有时会导致浏览器崩溃，团队知道，希望我们能尽快得到修复。

现在不再支持您的版本 (2.x)，因此不会有修复...
你试过Swagger-Net吗？那是我的 fork，我正在使用最新版本的 UI

Answer 2

这是一个似乎可以“修复”它的 hack。我将此添加到我的SwaggerConfig.cs

  c.MapType<MasterModel>(() => new Schema { type = "integer", format = "int32" });
  c.MapType<MasterLocationModel>(() => new Schema { type = "integer", format = "int32" });
  c.MapType<LocationModel>(() => new Schema { type = "integer", format = "int32" });

我有更多类型，但这三个是中心类型，因此通过将它们映射到整数，可以将递归限制在合理的水平。它也使招摇页面错误，但至少它加载！

也许有一种方法可以更好地使用SchemaFilter？任何帮助将不胜感激。

编辑：

最后，我们决定拆分我们的类，这样 swagger 就不能看到超过一层的引用。例如，

class A_Base {
   int id;
}

class A : A_Base {
   List<B_Base> Blist;
}

class B_Base {
   int id;
}

class B : B_Base {
   List<C_Base> Clist;
}

class C_Base {
   int id;
}

class C : C_Base {
   List<D_Base> Dlist;
}

我们所有的控制器 API 都使用 A、B、C 类型。swagger 文档只会深入一层。递归并没有完全失控。它也更正确，因为我们的 API 返回的对象通常只有零或一级深度。