• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    公众号

Asp.Net之WebApi线上调试插件Swagger

原作者: [db:作者] 来自: [db:来源] 收藏 邀请

这里不做Swagger插件的详细介绍,需要了解细节的自行google和百度。

在实际工作中,我们封装好了webapi,但是如果需要提供给别人调试需要将webapi部署在服务器上。同时将接口文档提供给第三方。

使用了Swagger的好处是除了可以直接在指定的地址上对我们的api进行调试,还能将我们api的注解提供出来,很大程度上代替了传统的接口文档。

使用方式如下:

1、在Nuge上安装下面几个包

2、项目生成配置项选择输出xml文档文件

3、找到SwaggerNet,如下图屏蔽两行代码

4、在SwaggerConfig类中加入下面方法

   private static string GetXmlCommentsPath()
        {
            //demo.xml是你的webapi所属项目的名称
            return string.Format("{0}/bin/demo.XML", 
           System.AppDomain.CurrentDomain.BaseDirectory);
        }

5、在SwaggerConfig类的Register方法中加上c.IncludeXmlComments(GetXmlCommentsPath());

 

 

至此,就都搭建好了。。。你可以按F5调试了,在浏览器的目录后面加上/swagger即可跳转到swagger调试页,如图:

然而,你会发现在控制器中加了action后发现在swagger找不到,这是为啥? 如果出现这个情况,你在action上面加下特性route("action名称")试试?如下图:

 

 

加上特性后:

 


鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
上一篇:
[总结]Asp.net中的页面乱码的问题发布时间:2022-07-10
下一篇:
8/18/2007 links: ASP.NET, ADO.NET, SQLSERVER, VS2005 and Others发布时间:2022-07-10
热门推荐
热门话题
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap