尧图网站建设 尧图网络
  • 首页
  • 关于我们
  • 服务项目
  • 案例展示
  • 建站流程
  • 资讯中心
  • 联系我们
首页/资讯中心/详情

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

ASP.NET Core Web API 为 Swagger 创建多个分组文档
📅 发布时间:2026/6/20 18:28:16
ASP.NET Core Web API 为 Swagger 创建多个分组文档的教程,我们主要可以通过 `AddSwaggerGen`、`SwaggerDoc`、`UseSwaggerUI`、`SwaggerEndpoint`、`ApiExplorerSettingsAttribute` 这几个 API 进行相关的编辑,实现在右上角 Select a definition 处将内容展开为更多信息。

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

一、效果展示

image
我们主要可以通过 AddSwaggerGen、SwaggerDoc、UseSwaggerUI、SwaggerEndpoint、ApiExplorerSettingsAttribute 这几个 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 的一些指导。

相关新闻

  • 2025年开式冷却塔生产厂家权威推荐榜单:闭式冷却塔/大型冷却塔/空冷器源头厂家精选
  • 2025年树脂拉链制造企业权威推荐榜单:尼龙拉链/金属拉链/隐形拉链源头厂家精选
  • 2025苏州最好的留学机构是哪家公司

最新新闻

  • 2026年6月核心快讯:从南京欧米茄正规授权维保资质查询到上海认证技师服务 - 亨得利官方售后
  • 太原单位搬家|太原公司搬迁专业服务商,福康搬家高分优选 - 速递信息
  • 太原长途搬家哪家专业?太原福康搬家省内长短途货运靠谱 - 速递信息
  • 2026EMBA排名测评:高管科学择校选型指南 - 品牌2026推荐
  • 【机翻】关于 ETW 内部结构:架构、钩子、篡改和检测(About ETW Internals: Architecture, Hooking, Tampering, and Detection )
  • BlenderGIS三维地理数据可视化:5分钟快速上手指南

日新闻

  • Visual C++运行库修复终极指南:5分钟快速解决Windows软件启动错误
  • 手把手教你构建统计局地区经济数据爬虫:从环境搭建到数据持久化全指南
  • 2026多Agent深度解析:用AI团队替代单一模型,四种架构实战落地

周新闻

  • Visual C++运行库修复终极指南:5分钟快速解决Windows软件启动错误
  • 手把手教你构建统计局地区经济数据爬虫:从环境搭建到数据持久化全指南
  • 2026多Agent深度解析:用AI团队替代单一模型,四种架构实战落地

月新闻

  • 【总结】入门篇:50句话让你记住架构核心概念
  • WeChatMsg技术方案解析:实现Mac微信数据自主管理的完整解决方案
  • WeChatMsg:革新性微信数据备份方案,打造你的专属数字记忆库

关于尧图

  • 公司简介
  • 团队介绍
  • 企业文化
  • 荣誉资质

服务项目

  • 定制开发
  • 电商建站
  • UI 设计
  • 运维服务

快速链接

  • 案例展示
  • 建站流程
  • 常见问题
  • 资讯中心

联系方式

  • 📍北京市朝阳区互联网产业园 A 座 10 层
  • 📞400-888-8888
  • ✉️contact@rkmt.cn
  • 🕐周一至周日 9:00-21:00

© 2024 北京尧图网络科技有限公司 版权所有 | 京 ICP 备 XXXXXXXX 号