通过Swashbuckle CLI工具生成摇摇欲坠时缺少XML注释

时间:2019-01-15 20:06:12

标签: asp.net-core .net-core swagger swashbuckle

我正在使用带有Asp.Net Core 2.2的Swashbuckle V4.0.0。我正在使用XML注释来记录我的Swagger。当我通过HTTP端点大张旗鼓时,一切都很好。当我运行dotnet swagger tofile时,我得到了swagger但没有包含XML注释。其他人是否可以通过CLI工具使用XML注释?

我已经查看了Swashbuckle CLI代码,但不确定它在创建构建器时如何调用启动代码。我已经包含了有关如何告诉Swashbuckle使用哪些文件的代码。这段代码在Startup.ConfigureServices中。我的主项目和几个库项目中都有XML文件,因此我编写了一个函数来查找它们。此函数返回有效文件,并且在从http请求摇摇欲坠时完美工作。我因做错了事而茫然。

var xmlFiles = GetXmlFiles(apiName);
services.AddSwaggerGen(
    options =>
    {
        // add a custom operation filter which sets default values
        options.OperationFilter<SwaggerDefaultValues>();

        // integrate xml comments
        foreach (string s in xmlFiles)
        {
            options.IncludeXmlComments(s);
        }
    });

0 个答案:

没有答案