.Net Core 将 Swashbuckle favicon 从自定义 html 更改为

问题描述 投票：0回答：2

我正在尝试为我们的 .net core api 自定义 favicon 并将其设置为项目结构中的图像。我无法加载它，并且尝试了一些不起作用的方法。这就是我在 Startup.cs 中使用 Swashbuckle 的自定义 html 的方式（位于名为 Swagger 的文件夹中）：

app.UseSwaggerUI(c =>
            {
                c.IndexStream = () => GetType().GetTypeInfo().Assembly
                    .GetManifestResourceStream("MyProject.Swagger.index.html");
            });

尝试＃1：

将 StaticFiles 的使用添加到我的 Startup.cs 配置方法中，如下所示：

app.UseStaticFiles();

然后我将 logo.png（设置为始终复制）放在 Images 文件夹下的 wwwroot 文件夹中，并尝试像这样在 html 中引用它。 （我还尝试从与 html 位于同一目录中的图像文件夹中引用它）。

<link rel="icon" type="image/png" href="~/Images/logo.png" />

没有骰子，选项卡中现在没有图标。

尝试＃2。

通过 html 文件中的 Javascript 覆盖 favicon。

var link = document.querySelector("link[rel*='icon']") || document.createElement('link');
link.type = 'image/png';
link.rel = 'icon';
link.href = '~/Images/logo.png';
document.getElementsByTagName('head')[0].appendChild(link);

没有骰子，招摇的图标仍然存在。

有人成功地使用 Swashbuckle 替换了图标吗？

我使用的 Swashbuckle 版本是 

Swashbuckle.AspNetCore 2.4.0

这是我根据此处的默认文件使用的html文件https://github.com/domaindrivendev/Swashbuckle.AspNetCore/blob/master/src/Swashbuckle.AspNetCore.SwaggerUI/index.html

<!-- HTML for static distribution bundle build -->
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>%(DocumentTitle)</title>
    <link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700|Source+Code+Pro:300,600|Titillium+Web:400,600,700" rel="stylesheet">
    <link rel="stylesheet" type="text/css" href="./swagger-ui.css">
    <link rel="icon" type="image/png" href="~/Images/logo.png" />
    <style>
        html {
            box-sizing: border-box;
            overflow: -moz-scrollbars-vertical;
            overflow-y: scroll;
        }

        *,
        *:before,
        *:after {
            box-sizing: inherit;
        }

        body {
            margin: 0;
            background: #fafafa;
        }
        hgroup.main {
            display: none;
        }
        .swagger-ui .topbar {
            background-color: #00CCCC;
        }
    </style>
    %(HeadContent)
</head>

<body>

    <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="position:absolute;width:0;height:0">
        <defs>
            <symbol viewBox="0 0 20 20" id="unlocked">
                <path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V6h2v-.801C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8z"></path>
            </symbol>

            <symbol viewBox="0 0 20 20" id="locked">
                <path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8zM12 8H8V5.199C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8z" />
            </symbol>

            <symbol viewBox="0 0 20 20" id="close">
                <path d="M14.348 14.849c-.469.469-1.229.469-1.697 0L10 11.819l-2.651 3.029c-.469.469-1.229.469-1.697 0-.469-.469-.469-1.229 0-1.697l2.758-3.15-2.759-3.152c-.469-.469-.469-1.228 0-1.697.469-.469 1.228-.469 1.697 0L10 8.183l2.651-3.031c.469-.469 1.228-.469 1.697 0 .469.469.469 1.229 0 1.697l-2.758 3.152 2.758 3.15c.469.469.469 1.229 0 1.698z" />
            </symbol>

            <symbol viewBox="0 0 20 20" id="large-arrow">
                <path d="M13.25 10L6.109 2.58c-.268-.27-.268-.707 0-.979.268-.27.701-.27.969 0l7.83 7.908c.268.271.268.709 0 .979l-7.83 7.908c-.268.271-.701.27-.969 0-.268-.269-.268-.707 0-.979L13.25 10z" />
            </symbol>

            <symbol viewBox="0 0 20 20" id="large-arrow-down">
                <path d="M17.418 6.109c.272-.268.709-.268.979 0s.271.701 0 .969l-7.908 7.83c-.27.268-.707.268-.979 0l-7.908-7.83c-.27-.268-.27-.701 0-.969.271-.268.709-.268.979 0L10 13.25l7.418-7.141z" />
            </symbol>


            <symbol viewBox="0 0 24 24" id="jump-to">
                <path d="M19 7v4H5.83l3.58-3.59L8 6l-6 6 6 6 1.41-1.41L5.83 13H21V7z" />
            </symbol>

            <symbol viewBox="0 0 24 24" id="expand">
                <path d="M10 18h4v-2h-4v2zM3 6v2h18V6H3zm3 7h12v-2H6v2z" />
            </symbol>

        </defs>
    </svg>

    <div id="swagger-ui"></div>

    <!-- Workaround for https://github.com/swagger-api/swagger-editor/issues/1371 -->
    <script>
        if (window.navigator.userAgent.indexOf("Edge") > -1) {
            console.log("Removing native Edge fetch in favor of swagger-ui's polyfill")
            window.fetch = undefined;
        }
    </script>

    <script src="./swagger-ui-bundle.js"></script>
    <script src="./swagger-ui-standalone-preset.js"></script>
    <script>
        window.onload = function () {
            var configObject = JSON.parse('%(ConfigObject)');
            var oauthConfigObject = JSON.parse('%(OAuthConfigObject)');

            // Apply mandatory parameters
            configObject.dom_id = "#swagger-ui";
            configObject.presets = [SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset];
            configObject.layout = "StandaloneLayout";

            // If oauth2RedirectUrl isn't specified, use the built-in default
            if (!configObject.hasOwnProperty("oauth2RedirectUrl"))
                configObject.oauth2RedirectUrl = window.location.href.replace("index.html", "oauth2-redirect.html");

            // Build a system
            const ui = SwaggerUIBundle(configObject);

            // Apply OAuth config
            ui.initOAuth(oauthConfigObject);

            //Custom scripting
            document.getElementsByClassName("link")[0].innerHTML = "Application Name";
            document.getElementsByClassName("link")[0].removeAttribute("href");
        }
    </script>
</body>

swagger swagger-ui swagger-2.0 swashbuckle
2个回答
0
投票

我遇到了类似的问题。但是，我使用了位于此处的索引：

https://github.com/domaindrivendev/Swashbuckle.AspNetCore/tree/master/test/WebSites/CustomUIIndex/Swagger

从这里，我可以使用以下内容更改徽标：

<div id="header">
    <section class="swagger-ui swagger-container" data-reactroot="">
        <div class="topbar">
            <div class="wrapper">
                <div class="topbar-wrapper">
                    <a class="link">
                        <img alt="Swagger UI" src="/Swagger/UI/Logo.jpg" />
                        <span style="font-size:medium; color:black;text-wrap:none;text-align:right" >YourTitle</span>
                    </a>
                </div>
            </div>
        </div>
    </section>
</div>
0
投票

在较新的

Swashbuckle.AspNetCore
中，您可以执行以下操作：

app.UseSwaggerUI(options => {
  options.HeadContent = "<link rel=\"icon\" type=\"image/png\" href=\"https://site/favicon.ico\" sizes=\"16x16\"

它将覆盖 html 中先前提供的默认图标。

您可能需要提供所有/更多尺寸。

应该可以与本地 

wwwroot
图标配合使用。

最新问题
© www.soinside.com 2019 - 2024. All rights reserved.