使用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。