时间戳

首页 > 解决方案 > Swagger XML 评论文件 - 缺少评论

asp.net-web-api2 - Swagger XML 评论文件 - 缺少评论

问题描述

我使用 Swashbuckle.Core 5.6.0 为我的 Web API 2 API 自托管 Swagger 文档

我在 Startup.cs 中启用 Swagger，如下所示

config.EnableSwagger(c => 
        {
            c.SingleApiVersion("v1", "AUDM API");
            c.IncludeXmlComments(AppDomain.CurrentDomain.BaseDirectory + "commentsfile1.xml");
            c.IncludeXmlComments(AppDomain.CurrentDomain.BaseDirectory + "commentsfile2.xml");
            c.DescribeAllEnumsAsStrings();
        }).EnableSwaggerUi(/*x => x.DisableValidator()*/);

swagger ui 显示得很好，列出了我所有的端点和方法。但是，文档为零.. 我在控制器中的所有评论和评论都不见了，就像

当我调试并查看我的 XML 文件的两个完全限定路径时，它们在运行时解析得很好，所以我假设应该没问题。

这两个 xml 文件来自不同的库，但这没关系，如果它..文件在那里，恕我直言，它们应该被使用。有没有办法解决为什么 XML 文件没有被拾取？

标签： asp.net-web-api2swaggerswashbucklexml-comments

解决方案

我认为您可能\在路径中缺少斜杠，请尝试以下操作：

c.IncludeXmlComments(AppDomain.CurrentDomain.BaseDirectory + "\commentsfile1.xml");

这是来自官方项目的示例： https ://github.com/domaindrivendev/Swashbuckle/blob/5489aca0d2dd7946f5569341f621f581720d4634/Swashbuckle.Dummy.Core/App_Start/SwaggerConfig.cs#L261

推荐阅读