C#方便配置Swagger

本文详细介绍了如何在C#的WebAPI项目中安装Swagger和SwaggerUI,配置XML文档以实现注解显示,并在Controller中添加Response.Redirect指向SwaggerUI。
摘要由CSDN通过智能技术生成

C# 在webapi项目中快捷方便配置Swagger(亲测好用)

1.安装swagger+swagger ui包
打开nuget界面,搜索swagger,并安装下面两个
在这里插入图片描述
安装完成之后,可以看到这些类与文件都是安装完成时swagger添加的
在这里插入图片描述

2.打开xml文档文件
右键项目属性—>生成—>勾选XML文档文件
在这里插入图片描述
3.SwaggerNet类中,注释类上面的两行,就会运行成功
在这里插入图片描述
4.这时,运行成功
在这里插入图片描述
5.添加注释
我们发现,安装完成后,写注释并没有在swagger页面上面增加,所以我们现在开开启注释

在SwaggerConfig类中,EnableSwagger的时候添加下面XML解析

c.IncludeXmlComments(GetXmlCommentsPath());
//添加XML解析方法
private static string GetXmlCommentsPath()
{
return string.Format(“{0}/bin/TestSwagger.XML”, System.AppDomain.CurrentDomain.BaseDirectory);
}
在这里插入图片描述
复制代码
注意修改相应的XML名字。

6.更改HomeController方法,增加 Response.Redirect(“/swagger/ui/index”);
在这里插入图片描述
完成!!

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值