在 Swagger for .NET Core 3.1 中使用自定义索引

Question

通过网络搜索我发现我可以大摇大摆地替换index.html文件。我遵循大多数人所说的，我可以用自定义文件替换索引文件。只需在您的项目中放置一个 index.html 某处，将其标记为嵌入资源并在 Startup class.

的 Configure 函数中添加几行

然后我从git项目（https://github.com/domaindrivendev/Swashbuckle.AspNetCore/blob/master/src/Swashbuckle.AspNetCore.SwaggerUI/index.html）复制索引文件进行修改

我的自定义索引位于名为 Swagger 的文件夹下，并且加载良好。但是一旦我重新加载页面，我就会得到一个异常：“ArgumentException：Stream 不可读。”。

我的配置选项如下所示：

string path = GetType().Namespace + ".Swagger.index.html";
var resource = GetType().Assembly.GetManifestResourceStream(path);

app.UseSwagger(config => { config.RouteTemplate = $"{doc_path}/{{documentName}}/{doc_file}"; });
app.UseSwaggerUI(config =>
{
    config.RoutePrefix = doc_path;
    config.SwaggerEndpoint($"{doc_vers}/{doc_file}", "Rest API Doc");
    config.InjectStylesheet($"style.css");
    config.IndexStream = () => resource);
});

我也尝试将 index.html 放在 wwwroot 文件夹下，它再次加载，但情况变得更糟。网站仅在 javascript 控制台显示 %(HeadContent)、%(DocumentTitle) 和一些错误。

Answer 1

问题是从 IndexStream 的 lambda 表达式创建资源路径字符串。这都是关于 .net 核心如何处理不同的 api 调用以及它如何为每个调用构造对象。

我必须替换这行：

string path = GetType().Namespace + ".Swagger.index.html";
var resource = GetType().Assembly.GetManifestResourceStream(path);

app.UseSwaggerUI(config =>
{
    -- some code here
    config.IndexStream = () => resource);
});

由此:

app.UseSwaggerUI(config =>
{
    -- some code here
    config.IndexStream = () => GetType().Assembly.GetManifestResourceStream
    (
            GetType().Namespace + ".Swagger.index.html")
    );
});

关于把index.html放在wwwroot文件夹下，swagger好像是给文件替换了一些文本，如果索引文件是用IndexStream函数note引用的话是做不到的。

在 Swagger for .NET Core 3.1 中使用自定义索引

Using Custom Index in Swagger for .NET Core 3.1

swagger

swagger-ui

.net-core

swashbuckle