Asp.Net Mvc WebApi集成Swagger

看到好多都用Swagger生成API文档,但是在网上找了几个blog根据写了之后,发现一下坑,现记录下来

1、新建一个项目,SwaggerMvc5Demo,如果选择mvc项目,需要引用web API引用。或者直接选择Web API项目。

2、添加对Swagger的引用:在nuget中搜索:Swashbuckle,现在的版本为5.6.0;进行安装

3、点击项目->属性->生成,在输出栏中选择:XML文档文件,前面的复选框进行打勾。生成xml文档

4、配置SwaggerConfig.cs文件

在EnableSwagger中找到注释的内容:

注释内容: 

//c.IncludeXmlComments(GetXmlCommentsPath());

 大约在104行,取消注释,添加方法:GetXmlCommentsPath(),返回项目xml文件所在路径

protected static string GetXmlCommentsPath()
{
     return $"{System.AppDomain.CurrentDomain.BaseDirectory}\\bin\\SwaggerMvc5Demo.xml";
}

 5、在_Layout.cshtml中添加超链接到swagger

6、点击CTRL+F5,运行项目,点击Swagger Help,看到界面如下,有可能controller的方法时隐藏的,只需点击Show/Hide进行显示/隐藏操作即可


  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值