创建Swagger UI

使用webapi都有一个棘手的问题，就是接口的测试。get方法还好说，post、put、delete等方法光测试就得费半天劲儿，有些时候还得运行程序，太麻烦。swagger UI帮我们解决了这个问题，可以通过界面化的方式来测试接口。下面来详细介绍一个swagger UI环境的搭建。

1. 首先，创建webpapi类型的项目 

2. 安装swagger+swagger ui包

打开nuget界面，搜索swagger，并安装下面两个

安装完成之后，可以看到这些类与文件都是安装完成时swagger添加的

3. 打开xml文档文件

右键项目属性—>生成—>勾选XML文档文件

4. 运行

做好上述步骤后，运行，我发现我报错了

 

发生上述错误，请在，SwaggerNet类中，注释类上面的两行，就会运行成功

 

 这时，运行成功

5. 添加注释

我们发现，安装完成后，写注释并没有在swagger页面上面增加，所以我们现在开开启注释

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

c.IncludeXmlComments(GetXmlCommentsPath());

　　其中GetXmlCommentsPath()这个方法的代码如下：

        private static string GetXmlCommentsPath()
        {
            return string.Format("{0}/bin/WebApplication2.XML", System.AppDomain.CurrentDomain.BaseDirectory);//注意xml文档的路径
        }

　　这样就ok了

 

 心得：有时候自己折腾半天，都不如问别人一句话，人一定不要羞于问问题