c# - 自定义 Swagger UI ASP.NET Core Web API

Question

我正在尝试在我的 ASP.NET Core Web API 上自定义 swagger UI。

我想要这样的用户界面:

我正在学习这些教程:

• 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

这是 Startup.cs 配置:

// Add the detail information for the API.
services.ConfigureSwaggerGen(options =>
{
    // Determine base path for the application.
    var basePath = _env.WebRootPath;

    // Complete path
    var xmlPath = Path.Combine(basePath, "myapi.xml");

    // Set the comments path for the swagger json and ui.
    options.IncludeXmlComments(xmlPath);
});

app.UseStaticFiles();

// Enable middleware to serve generated Swagger as a JSON endpoint
app.UseSwagger();

// Enable middleware to serve swagger-ui assets (HTML, JS, CSS etc.)
app.UseSwaggerUI(c =>
{                
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "MyAPI");
});  

我已经从 git 存储库下载了 swagger ui 文件并像这样放在我的项目中:

我不知道这样做是否正确，但我看不到 swagger UI 有任何变化。

Answer 1

您正在关注的教程正在使用:Swashbuckle.AspNetCore 不幸的是，在该项目中他们仍在使用 Swagger-UI 2.x 版，您的屏幕截图显示的是 3.x 版

有一些 Pull Requests 可以更新到最新的 Swagger-UI:

• https://github.com/domaindrivendev/Swashbuckle.AspNetCore/pull/453
• https://github.com/domaindrivendev/Swashbuckle.AspNetCore/pull/543

但不幸的是，在合并这些方面没有太大进展。

我看到您知道如何从 git 存储库下载文件...
我的建议:
不要下载 swagger-ui 文件，而是从使用您需要的版本(例如:alexvaluyskiy/Swashbuckle.AspNetCore)的 fork 下载整个项目 Swashbuckle.AspNetCore，然后在您的项目中添加对该项目的引用而不是 nuget 包.

另一种选择是创建您自己的 Swashbuckle 分支。AspNetCore 合并您需要的修复程序，然后使用不同的名称发布您自己的 Nuget 包。