IGeekFan.AspNetCore.Knife4jUI 使用教程-EW帮帮网

IGeekFan.AspNetCore.Knife4jUI 使用教程

IGeekFan.AspNetCore.Knife4jUIsupport .NET Core3.0+,.NET Standard2.0 Swagger UI knife4j ui，you can use NSwagger or Swashbuckle.AspNetCore in packages项目地址:https://gitcode.com/gh_mirrors/ig/IGeekFan.AspNetCore.Knife4jUI

项目介绍

IGeekFan.AspNetCore.Knife4jUI 是一个支持 .NET Core 3.0+ 和 .NET Standard 2.0 的 Swagger UI 库。它基于 knife4j UI，提供了美观且功能强大的 API 文档界面。用户可以通过集成 NSwagger 或 Swashbuckle.AspNetCore 来使用此库，以便在 ASP.NET Core 应用程序中生成和展示 API 文档。

项目快速启动

安装包

首先，需要在你的 ASP.NET Core 应用程序中安装 IGeekFan.AspNetCore.Knife4jUI 包。可以使用以下命令进行安装：

# 使用 Package Manager
Install-Package IGeekFan.AspNetCore.Knife4jUI

# 使用 .NET CLI
dotnet add package IGeekFan.AspNetCore.Knife4jUI

配置服务

在 Startup.cs 文件的 ConfigureServices 方法中注册 Swagger 生成器，并定义一个或多个 Swagger 文档。

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();

    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo { Title = "API V1", Version = "v1" });
        c.AddServer(new OpenApiServer() { Url = "", Description = "vvv" });
        c.CustomOperationIds(apiDesc =>
        {
            var controllerAction = apiDesc.ActionDescriptor as ControllerActionDescriptor;
            return controllerAction?.ActionName;
        });
    });
}

配置中间件

在 Startup.cs 文件的 Configure 方法中启用 Swagger 中间件。

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    app.UseRouting();

    app.UseSwagger();
    app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint("/swagger/v1/swagger.json", "API V1");
    });

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllers();
    });
}

应用案例和最佳实践

应用案例

IGeekFan.AspNetCore.Knife4jUI 可以广泛应用于需要展示 API 文档的 ASP.NET Core 项目中。例如，一个电商平台的后端服务，通过集成此库，可以方便前端开发者查看和测试 API 接口。

最佳实践

文档版本管理：在 AddSwaggerGen 方法中定义多个版本的 Swagger 文档，以便管理不同版本的 API。
自定义操作 ID：通过 CustomOperationIds 方法自定义操作 ID，使 API 文档更加清晰易读。
服务器配置：使用 AddServer 方法配置多个服务器地址，方便在不同环境中测试和部署。

典型生态项目

IGeekFan.AspNetCore.Knife4jUI 可以与以下生态项目结合使用：

Swashbuckle.AspNetCore：用于生成 Swagger 文档的核心库。
NSwag：另一个流行的 Swagger/OpenAPI 工具，可以生成客户端代码和 API 文档。
knife4j：提供美观的 Swagger UI 界面，是 IGeekFan.AspNetCore.Knife4jUI 的基础。

通过这些生态项目的结合使用，可以构建一个功能完善且界面友好的 API 文档系统。

IGeekFan.AspNetCore.Knife4jUI 使用教程