使用 Swashbuckle.AspNetCore 的消息总线消息文档？

Question

我正在考虑在我的 ASP.Net Core 项目中使用 Swashbuckle.AspNetCore v4.0.1 NuGet 包为我的 Web API 生成一个 SwaggerUI 文档端点，我公司内部的各个团队将使用该端点。我的 API 使用并发出一些消息总线事件和命令，我希望将它们包含在该文档中。

Swashbuckle 的中间件中是否有任何自定义设置允许我记录与 API 端点无关的输入/输出对象？

Answer 1

端点发出服务总线事件是内部实现细节，不需要记录。

如果您想为端点提供文档，您可以编写 XML 文档并配置 Swashbuckle 以使用 IncludeXmlComments 方法公开该文档。

Microsoft 在其Get started with Swashbuckle and ASP.NET Core 文章中解释了如何以这种方式配置 Swagger。