Swagger XML评论文件 - 缺少评论

问题描述 投票:1回答:1

我使用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-api2 swagger swashbuckle xml-comments
1个回答
0
投票

我认为你可能在路径中缺少斜线\,试试这个:

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

以下是官方项目的样本:https://github.com/domaindrivendev/Swashbuckle/blob/5489aca0d2dd7946f5569341f621f581720d4634/Swashbuckle.Dummy.Core/App_Start/SwaggerConfig.cs#L261

© www.soinside.com 2019 - 2024. All rights reserved.