提问者:小点点

问题使用自定义index. Html在Swagger/SwashBuckle.NET核心


我在使用自定义index. html和其他带有swash巴克尔的资产时遇到了困难。Swash巴克尔/Swagger似乎根本无法识别或使用它们。我确实设置了app.UseDefaultFiles()和app.UseStticFiles()。我试图理解我做错了什么。

我试图设置我的配置有点类似于微软文章中定义的配置,但没有成功。(https://learn.microsoft.com/en-us/aspnet/core/tutorials/web-api-help-pages-using-swagger?tabs=visual-studio)

我目前正在使用文章(https://github.com/swagger-api/swagger-ui/tree/2.x/dist)中引用的dist文件夹中的文件以及提供的自定义css文件。

我的index. html文件位于 /wwwroot/swagger/用户界面下。自定义css文件位于 /wwwroot/swagger/用户界面/css下(如client.css)

这是我的Startup. cs课程。

public class Startup
{
    public Startup(IConfiguration configuration)
    {
        Configuration = configuration;
    }

    public IConfiguration Configuration { get; }

    // This method gets called by the runtime. Use this method to add services to the container.
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddMvc()
             .AddJsonOptions(options =>
             {
                 // Swagger - Format JSON
                 options.SerializerSettings.Formatting = Formatting.Indented;
             });

        // Register the Swagger generator, defining one or more Swagger documents
        services.AddSwaggerGen(c =>
        {
            c.DescribeAllEnumsAsStrings();
            c.DescribeStringEnumsInCamelCase();
            // c.DescribeAllParametersInCamelCase();                

            c.SwaggerDoc("v1",
                new Info
                {
                    Title = "My Web API - v1",
                    Version = "v1",
                    Description = "New and improved version. A simple example ASP.NET Core Web API. "

                }
            );

            c.SwaggerDoc("v2",
                new Info
                {
                    Title = "My Web API - v2",
                    Version = "v2",
                    Description = "New and improved version. A simple example ASP.NET Core Web API. "
                }
            );

            // Set the comments path for the Swagger JSON and UI.
            var basePath = AppContext.BaseDirectory;
            var xmlPath = Path.Combine(basePath, "ApiTest.xml");
            c.IncludeXmlComments(xmlPath);
        });

    }

    public void Configure(IApplicationBuilder app, IHostingEnvironment env)
    {
        string swaggerUIFilesPath = env.WebRootPath + "\\swagger\\ui";

        if (!string.IsNullOrEmpty(swaggerUIFilesPath))
        {
            app.UseDefaultFiles();
            app.UseStaticFiles(new StaticFileOptions
            {
                FileProvider = new PhysicalFileProvider(swaggerUIFilesPath),
                RequestPath = new PathString("/api-docs"),
            });
        }

        // Enable middleware to serve generated Swagger as a JSON endpoint.
        app.UseSwagger(c =>
        {
            c.RouteTemplate = "api-docs/{documentName}/swagger.json";
        });

        // Enable middleware to serve swagger-ui (HTML, JS, CSS, etc.), specifying the Swagger JSON endpoint.
        app.UseSwaggerUI(c =>
        {
            //c.ShowJsonEditor();
            c.RoutePrefix = "api-docs";
            c.SwaggerEndpoint("/api-docs/v1/swagger.json", "My Web API - V1 ");
            c.SwaggerEndpoint("/api-docs/v2/swagger.json", "My Web API - V2 ");
            c.DocumentTitle("My Web API");
        });

        app.UseMvc();
    }
}

我的最终目标是能够使用像这里(https://github.com/omnifone/slate-swagger-ui)提供的石板样式主题这样的东西。现在,我只是想在尝试使其他文件工作之前,让Swashuckle/Swagger使用Microsoft留档中引用的自定义文件。

我真的不想尝试将我的资产转换为嵌入式资源——因为会有很多。我只想引用一个普通的index. html文件并能够使用其所有引用的文件。

我做错了什么?

相关软件版本

  • 。Net Core版本:2.0.3
  • Swashuckle. AspNetCore:1.2.0
  • Windows 10 Enterprise Build 1703
  • Visual Studio 2017 Enterprise 15.5.2

共2个答案

匿名用户

以下是我发现替换SwashBuckle的index. html所需的最小操作。NET核心项目:

>

  • 从这里获取原始index. html的副本:https://github.com/domaindrivendev/Swashbuckle.AspNetCore/blob/master/src/Swashbuckle.AspNetCore.SwaggerUI/index.html

    将该副本放在项目的某个子文件夹中。
    该文件可能有不同的名称,我选择了:\Resources\Swagger_Custom_index. html

    在解决方案资源管理器中右键单击该文件,选择“属性”,在左窗格中选择“配置属性”。在右窗格的“高级”下找到条目“构建操作”并将其设置为“嵌入式资源”。单击确定。

    在Startup. cs中,将以下行添加到您的app.UseSwaggerUI()调用中:

    public void Configure(IApplicationBuilder app, IHostingEnvironment env)
    {
        //...
    
        app.UseSwaggerUI(c =>
        {
            c.IndexStream = () => GetType().GetTypeInfo().Assembly.GetManifestResourceStream("Your.Default.Namespace.Resources.Swagger_Custom_index.html");
        });
    
        //...
    }
    

    上述GetManifestResourceStream方法中文件资源的标识符由以下组成:

    1. 您的默认命名空间(即“您的. Default.Namespace”)
    2. 资源的子路径(即“资源”)
    3. 资源的文件名(即'Swagger_Custom_index. html')

    所有三个部分都使用点连接(此处没有斜杠或反斜杠)。
    如果您不使用子路径但将资源放在root中,只需省略第2部分。

  • 匿名用户

    对于在ASP.NETCore上分离ApplicationBuilder配置方法的人:

    如果分隔的方法/类是静态的,则无法调用GetType(),因为需要对象引用。

    在这种情况下,将GetType()切换到ControlodBase. GetCurrentMethod()。声明类型

    c.IndexStream = () => MethodBase.GetCurrentMethod().DeclaringType.Assembly.GetManifestResourceStream("xxx.index.html");
    

    相关问题