当前位置: 首页 > news >正文

.net core的Knife4jUI,让swagger更精致

要在 .NET Core 中使用 IGeekFan.AspNetCore.Knife4jUI,您可以按照以下步骤进行配置:

  1. 首先,安装 IGeekFan.AspNetCore.Knife4jUI NuGet 包。可以通过 Visual Studio 的 NuGet 包管理器或者 .NET CLI 进行安装。

  2. 在 Startup.cs 文件的 ConfigureServices 方法中,添加以下代码,来配置 IGeekFan.AspNetCore.Knife4jUI:

builder.Services.AddSwaggerGen(c =>
{// 配置 Swagger 文档相关信息c.SwaggerDoc("v1", new OpenApiInfo { Title = "API Documentation 123", Version = "v1" });// 配置 Swagger 生成的 XML 文档 【这样可是接口的注释展示出来】// 在项目属性中启用 XML 文档生成。右键点击项目,选择 "属性",在 "生成" 选项卡中勾选 "启用生成 XML 文档文件",并指定生成的 XML 文件的路径。请注意确保该 XML 文件存在,并与程序集名称一致。var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);c.IncludeXmlComments(xmlPath);// 可以在这里添加其他 Swagger 相关配置,例如添加身份验证信息等
});
  1. 在 Configure 方法中,确保在其他中间件之前启用 IGeekFan.AspNetCore.Knife4jUI:
if (app.Environment.IsDevelopment())
{app.UseSwagger();// app.UseSwaggerUI();app.UseKnife4UI(c =>{c.RoutePrefix = string.Empty;c.SwaggerEndpoint("/swagger/v1/swagger.json", "Your API V2");});
}app.UseAuthorization();app.UseEndpoints(endpoints =>
{endpoints.MapControllers();
});

这样就完成了 IGeekFan.AspNetCore.Knife4jUI 的配置。您可以在启动应用程序后,访问 https://localhost:7089/index.html#/home(具体地址取决于您的应用程序配置)来查看生成的 Swagger UI。
在这里插入图片描述

http://www.lryc.cn/news/122079.html

相关文章:

  • Android 开发中需要了解的 Gradle 知识
  • Linux之【进程间通信(IPC)】-总结篇
  • C++QT教程3——手册4.11.1自带教程(笔记)——创建一个基于Qt Widget的应用程序
  • 手机商城网站的分析与设计(论文+源码)_kaic
  • vue2 封装 webSocket 开箱即用
  • 使用fopen等标准C库来操作文件
  • Spring-Cloud-Loadblancer详细分析_1
  • 键盘键码keyCode对照表
  • jupyter切换conda虚拟环境
  • 【数据结构•堆】经典问题:k路归并
  • VUE3 动态路由
  • CentOS软件包管理rpm、yum
  • 【VSCode】报错:出现段错误解决办法 (Segmentation fault)
  • Linux Centos 8 用户管理之重置密码
  • C语言快速回顾(三)
  • 【Apollo】Apollo-ros版本架构学习与源码分析
  • 【Express.js】集成RabbitMQ
  • UI美工设计岗位的基本职责概述(合集)
  • 最强自动化测试框架Playwright(23)-API测试
  • k8s 自身原理 4
  • ZLMediaKit(webrtc)在linux上(CentOS7)部署与启动
  • 汽车基础软件新「战争」:群雄混战,谁在抢跑?
  • 阿里云预装LAMP应用导致MySQL不显示访问密码如何解决
  • SQL 自动清除7天前数据前收缩数据库
  • LangChain-ChatGLM在WIndows10下的部署
  • Telerik UI for ASP.NET Core Crack
  • 【TypeScript】中关于 { 声明合并 } 的使用及注意事项
  • Day 43
  • 服务器安全需要注意的几个方面?
  • Mysql数据库第十三课-----------sql语句的拔高3--------直冲云霄