Question

我是带有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文件来自不同的库，但这没关系，是否应该..这些文件在那里，所以应该使用IMHO。有没有办法解决为什么XML文件没有被拾取的问题？

Answer 1

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

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

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

Swagger XML注释文件-缺少注释

1 个答案: