Swagger 3.0 ASP.NET Core - 如何在请求正文和响应中添加模型架构文档

Question

我有 REST API 正文和响应的模型架构。 XML 注释已定义，但我无法想出一种方法来在 API 中包含 Swagger UI 3.0 中模型架构的 XML 文档body 和 response ?

Answer 1

我错过了这个，现在可以用了。我将模式分布在不同的 asp.net 核心程序集上，Swagger UI 3.0 确实支持添加多个 XML 源。

要包含控制器注释本身，我们必须设置 includeControllerXmlComments: true

c.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, "test1.xml"), includeControllerXmlComments: true);
c.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, "test2.xml"), includeControllerXmlComments: true);
c.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, "test3.xml"), includeControllerXmlComments: true);