首页 > 解决方案 > 通过 Swashbuckle CLI 工具生成招摇时缺少 XML 注释

问题描述

我正在使用带有 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 请求 swagger 时,此函数返回有效文件并完美运行。我为自己做错了什么而不知所措。

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);
        }
    });

标签: asp.net-core.net-coreswaggerswashbuckle

解决方案


推荐阅读