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

这里不做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名称")试试？如下图:

 

 

加上特性后: