.NET 8 knife4 WebAPI 文档

🏆作者：科技、互联网行业优质创作者
🏆专注领域：.Net技术、软件架构、人工智能、数字化转型、DeveloperSharp、微服务、工业互联网、智能制造
🏆欢迎关注我（Net数字智慧化基地），里面有很多高价值技术文章，是你刻苦努力也积累不到的经验，能助你快速成长。升职+涨薪！！

前言

knife4官网：https://github.com/luoyunchong/IGeekFan.AspNetCore.Knife4jUI

正文

1、创建.NET 8 Web API项目

2、nuget包管理添加如下包：

Swashbuckle.AspNetCore.Swagger` `Swashbuckle.AspNetCore.SwaggerGen` `IGeekFan.AspNetCore.Knife4jUI

3、在项目右键-属性-生成-输出 勾选 文档文件如图

保持，关闭。

项目右键，重新生产，再打开可以看到xml路径，可以复制填入API文档路径。

4、修改Program.cs文件如图

相关代码

using IGeekFan.AspNetCore.Knife4jUI;
using Microsoft.AspNetCore.Mvc.Controllers;
using Microsoft.OpenApi.Models;
using System.IO;
using System.Reflection;
 
var builder = WebApplication.CreateBuilder(args);
 
// Add services to the container.
builder.Services.AddSwaggerGen(c =>
{
    // 配置 Swagger 文档相关信息
    c.SwaggerDoc("v1", new OpenApiInfo
    {
        Title = "Knife4 Api文档测试项目",
        Version = "v2.0",
        Description = "Knife4测试"
    });
 
    // 配置 Swagger 生成的 XML 文档 【这样可是接口的注释展示出来】
    // 在项目属性中启用 XML 文档生成。右键点击项目，选择 "属性"，在 "生成" 选项卡中勾选 "启用生成 XML 文档文件"，
    // 并指定生成的 XML 文件的路径。请注意确保该 XML 文件存在，并与程序集名称一致。
    var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";//获取xml名称
    var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);//转换xml路径
    c.IncludeXmlComments(xmlPath, true);//true显示控制器的注释，否则不显示
    c.OrderActionsBy(o => o.RelativePath); // 对action的名称进行排序，如果有多个，就可以看见效果了。
});
builder.Services.AddControllers();
 
var app = builder.Build();
 
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
 
    // app.UseSwaggerUI();
    app.UseKnife4UI(c =>
    {
        c.RoutePrefix = string.Empty;
        c.SwaggerEndpoint("/swagger/v1/swagger.json", "接口版本");
    });
}
 
app.UseAuthorization();
 
app.MapControllers();
 
app.Run();

5、控制器相关注释添加

6、运行看效果

到此，测试完成，其他的见官方文档进一步深入。谢谢。

🏆欢迎关注我（Net数字智慧化基地），里面有很多高价值技术文章，是你刻苦努力也积累不到的经验，能助你升职+涨薪！！
🏆点击下方卡片关注公众号，里面有很多大佬的技术文章，能助你快速成长。还可免费领取如下15个视频教程！

回复'面试'，获取C#/.NET/.NET Core面试宝典

回复'C#'，领取零基础学习C#编程

回复'NET'，领取.NET零基础入门到实战

回复'Linux'，领取Linux从入门到精通

回复'wpf'，领取高薪热门【WPF上位机+工业互联网】从零手写实战

回复'Modbus'，领取初识C#+上位机Modbus通信

回复'PLC'，领取C#语言与西门子PLC的通信实操

回复'blazor'，领取blazor从入门到实战

回复'TypeScript'，领取前端热门TypeScript系统教程

回复'vue'，领取vue前端从入门到精通

回复'23P'，领取C#实现23种常见设计模式

回复'MongoDB'，领取MongoDB实战

回复'Trans'，领取分布式事务

回复'Lock'，领取分布式锁实践

回复'Docker'，领取微服务+Docker综合实战

回复'K8s'，领取K8s部署微服务

回复'加群'，进.NET技术社区交流群