.NET CORE 使用Swagger

本文介绍如何使用NuGet为项目安装Swashbuckle.AspNetCore,并在Startup中配置服务和注册中间件,实现API接口注释显示。通过调整SwaggerGen设置,包括XML文件的包含和控制器注释的显示,确保API文档完整。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

NuGet给项目安装包文件Swashbuckle.AspNetCore

  1. 在Starup中注入服务和注册中间件
  2.   
  3.  配置以上条件后运行项目然后在地址栏输入https://localhost:44381/swagger/index.html

                 得到以下运行效果,看到以下图片不是很满意,跟博客大佬的不是相同,没有接口注释 

4. 启用xml

 

 在修改

 //注册swagger服务
            services.AddSwaggerGen(s =>
            {
                s.SwaggerDoc("v1", new OpenApiInfo { Title = "XC API", Version = "v1" });
                // 获取xml文件名
                var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
                // 获取xml文件路径
                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
                // 添加控制器层注释,true表示显示控制器注释
                s.IncludeXmlComments(xmlPath, true);
            });

创建拓展方法并且注册使用

 

 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值