.net core8 使用Swagger（附当前源码）

五味茶

说明

   该文章是属于OverallAuth2.0系列文章，每周更新一篇该系列文章（从0到1完成系统开发）。
    该系统文章，我会尽量说的非常详细，做到不管新手、老手都能看懂。
    说明：OverallAuth2.0 是一个简单、易懂、功能强大的权限+可视化流程管理系统。
有兴趣的朋友，请关注我吧(*^▽^*)。
使用前提

1、Visual Studio使用2022版本

搭建项目

    OverallAuth2.0依然和OverallAuth1.0一样，采用前后端分离模式，所以搭建后端，我们选择  .net core web api（如下图）

 
    选择项目模板后，我们点击【下一步】

 
选择.net 8.0(最新长期支持版本)，随后创建项目
默认项目结构如下图

 
直接运行，查看默认界面

 
    运行起来可以看到，系统默认的swagger界面非常简介，也少了很多信息比如：
1、系统说明、版本、作者等。
2、接口的描述、参数等信息。
3、接口的分类等。
优化Swagger

    上面说道，系统默认的接口文档是非常简洁的，接下来我们在系统中，这样做，让swagger看起来更优美和专业。
 在项目下新增一个文件件PlugInUnit，然后再该文件夹下新建一个类SwaggerPlugInUnit。

      建好SwaggerPlugInUnit后，在webapi同级建一个类库Utility，用于存放系统的辅助工具等，然后再该类库下建一个Enum文件夹，并新建ModeuleGroupEnum该枚举。
如图：

 
建好文件后，在ModeuleGroupEnum文件中写一个枚举SysMenu，并保存。

1. /// <summary>
2. /// 模块分组
3. /// </summary>
4. public enum ModeuleGroupEnum
5. {
6.     SysMenu = 1,
7. }

复制代码

随后在SwaggerPlugInUnit中编写一个方法，具体代码如下

1. /// <summary>
2. /// swagger插件
3. /// </summary>
4. public static class SwaggerPlugInUnit
5. {
6.     /// <summary>
7.     /// 初始化Swagger
8.     /// </summary>
9.     /// <param name="services"></param>
10.     public static void InitSwagger(this IServiceCollection services)
11.     {
12.         //添加swagger
13.         services.AddSwaggerGen(optinos =>
14.         {
15.             typeof(ModeuleGroupEnum).GetEnumNames().ToList().ForEach(version =>
16.             {
17.                 optinos.SwaggerDoc(version, new OpenApiInfo()
18.                 {
19.                     Title = "权限管理系统",
20.                     Version = "V2.0",
21.                     Description = "求关注，求一键三连",
22.                     Contact = new OpenApiContact { Name = "微信公众号作者：不只是码农   b站作者：我不是码农呢", Url = new Uri("http://www.baidu.com") }
23.                 });
25.             });
27.             //反射获取接口及方法描述
28.             var xmlFileName = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
29.             optinos.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlFileName), true);
31.         });
32.     }
34.     /// <summary>
35.     /// swagger加入路由和管道
36.     /// </summary>
37.     /// <param name="app"></param>
38.     public static void InitSwagger(this WebApplication app)
39.     {
40.         app.UseSwagger();
41.         app.UseSwaggerUI(options =>
42.         {
43.             typeof(ModeuleGroupEnum).GetEnumNames().ToList().ForEach(versoin =>
44.             {
45.                 options.SwaggerEndpoint($"/swagger/{versoin}/swagger.json", $"接口分类{versoin}");
46.             });
47.         });
48.     }
49. }

复制代码

1. 然后再program中使用自定义swagger中间件<br><img src="https://img2024.cnblogs.com/blog/1158526/202409/1158526-20240912161439487-2111244537.png" alt="">

复制代码

   做好以上步骤，我们的swagger基本算是搭建好了，只需要在控制器上方，添加路由和分组。

1. /// <summary>
2. /// 系统模块
3. /// </summary>
4. [ApiController]
5. [Route("api/[controller]/[action]")]
6. [ApiExplorerSettings(GroupName = nameof(ModeuleGroupEnum.SysMenu))]

复制代码

 
做完以上这些，我们对swagger就算优化完成，只需要运行系统，就可以查看效果

 
注意：必须生成接口的xml文件，不然会报错。

 
  好了，以上就是搭建WebApi+优化Swagger的全部过程，你快来试试吧
如果对你有帮助，请关注我吧(*^▽^*)。

源代码地址：https://gitee.com/yangguangchenjie/overall-auth2.0-web-api  

帮我Star，谢谢。
 
有兴趣的朋友，请关注我吧(*^▽^*)。

关注我：一个全栈多端的宝藏博主，定时分享技术文章，不定时分享开源项目。关注我，带你认识不一样的程序世界

来源:https://www.cnblogs.com/cyzf/p/18410483
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！