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

ASP.NET Core Web API 为 Swagger 创建多个分组文档

ASP.NET Core Web API 为 Swagger 创建多个分组文档

一、效果展示

image
我们主要可以通过 AddSwaggerGenSwaggerDocUseSwaggerUISwaggerEndpointApiExplorerSettingsAttribute 这几个 API 进行相关的编辑,实现在右上角 Select a definition 处将内容展开为更多信息。

二、为控制器标记组别名称

首先,你需要为你的控制器 Controller 添加特性 ApiExplorerSettingsAttribute[ApiExplorerSettings])。
就像下面的代码一样:

    [ApiController][Route("[controller]/[Action]")][ApiExplorerSettings(GroupName = "hello")] // 注意这一句,其中 GroupName 的 "hello" 就是组别的名字public class HelloController:ControllerBase{[HttpGet]public string Test(){return "11";}}

三、在 Program.cs 初始化,为 builder 配置相关服务

你需要将本来的builder.Services.AddSwaggerGen(); 拓展为下面的内容:

builder.Services.AddSwaggerGen(c =>
{c.SwaggerDoc("hello", new OpenApiInfo{Title = "你好!",Version = "v1",Description = "你好啊"});c.SwaggerDoc("weather-forecast", new OpenApiInfo{Title = "天气预报",Version = "v1",Description = "天气预报哦"});
});

四、在 Program.cs 初始化,为 app 配置文档关联

你可以app.UseSwaggerUI(); 拓展为:

app.UseSwaggerUI(c =>
{c.SwaggerEndpoint("/swagger/hello/swagger.json", "hello");c.SwaggerEndpoint("/swagger/weather-forecast/swagger.json", "weather-forecast");
});

五、其它

本文感谢 kimi ai 的一些指导。

http://www.rkmt.cn/news/58732.html

相关文章:

  • 2025年开式冷却塔生产厂家权威推荐榜单:闭式冷却塔/大型冷却塔/空冷器源头厂家精选
  • 2025年树脂拉链制造企业权威推荐榜单:尼龙拉链/金属拉链/隐形拉链源头厂家精选
  • 2025苏州最好的留学机构是哪家公司
  • 2025年托盘式不锈钢电缆桥架源头厂家权威推荐榜单:不锈钢电缆桥架/节能型桥架/聚氨酯管箱源头厂家精选
  • 2025年江苏saas小程序制作平台权威推荐榜单:江苏电商小程序定制服务/江苏小程序制作公司/江苏电商小程序服务商平台精选
  • 【前端小站】CSS 样式美学:从基础语法到界面精筑的实战宝典 - 实践
  • 2025年GEO公司综合实力排行榜:上饶大牛数据服务有限公司领跑行业
  • 本年口碑好的GEO品牌推荐
  • 2025配置管理平台选型:如何破解CMDB建设痛点,从需求匹配到产品选型的实战指南
  • 2025广州哪家留学机构比较好一点
  • 2025大连靠谱留学机构
  • 2025新加坡留学中介排行
  • 2025苏州最好的留学机构在哪里啊
  • 2025 年 11 月激光切割钢结构,大型钢结构,C 型钢结构厂家最新推荐,聚焦资质、案例、售后的五家机构深度解读!
  • 2025 合同纠纷律师咨询最新推荐排行榜:股权债务 / 劳动仲裁 / 民商事诉讼顶尖法律顾问权威指南
  • 2025年北京儿童孤独症谱系障碍培训权威推荐榜单:儿童高功能自闭症/儿童注意力培训机构/儿童注意力集训营培训精选
  • 2025 最新聚合硫酸铁优质生产厂家最新推荐:覆盖多类型产品 解析实力厂商核心优势 助力采购方精准选品固态聚合硫酸铁 / 粉末聚合硫酸铁 / 硫酸亚铁公司推荐
  • 专访创一AI:2025年短剧革命,揭秘爆款背后的智能引擎
  • CH395Q INT脚变化说明
  • SpringCloud 常见面试题(三)
  • MySQL 8.4:未使用 mysql_native_password 却报插件未加载(Plugin mysql_native_password is not loaded)?
  • 水题乱做
  • 杂题选做-7
  • 软件设计实验十七与十八:迭代器模式,解释器模式
  • Ai元人文构想:从“题海战术”到“理解原理”:AI治理中规则逻辑与价值协议的差异论证与效率抉择
  • Gopeed跨终端下载神器测评:开源免费+远程控制,下载速度跑满带宽的秘诀! - 实践
  • 2025年知名的浴室柜平板铰链厂家最新推荐排行榜
  • 2025年知名的浮吊实力厂家TOP推荐榜
  • 2025年必备的6大AI论文生成器推荐,轻松搞定高质量论文!
  • 2025 年 11 月管理咨询机构权威推荐榜:战略规划、组织变革与数字化转型领域的顶尖智囊团队深度解析