使用Swagger实现webapi接口自动化文档生成

这里是实现自动化api稳当的生成，在网上看了很多swagger的文档，可能都是在为实现接口时直接使用的swagger，其实步骤差不多，但是更加详细的我还没看到，又或者说，我看着文档来的时候还是出错啦，绕了很大的弯，之前有听过要用这个，但是还是用过。接下来总结下我这次在使用过程中的步骤及一些问题。

在接口已经成型的基础上集成swagger，实现了接口文档的自动化生成，相对于开发来说节约了写文档的大部分时间，无疑是一件莫大的好事情。接下来总结下这个过程：

一、在现有Api的基础上添加Nuget包的引用（这里简述下现有api，不一定是webapi项目，要看接口实现在哪里，可以是类库，也可以是项目webapi等），有2个包，一个是Swagger.Net.UI，一个是Swashbuckle，如下图所示：

（1）、Swagger.Net.UI的添加引用：

（2）、Swashbuckled的添加引用

这里的版本是4.5.2的版本，可能在4.0版本上就不一样啦，这里我没有尝试。。。

二、安装成功后会有新增的文件如下所示：

                                 

三、在设置的启动项目下生成XML文件，步骤如下：

例如：我目前项目中有去实现接口的web项目，我就选择此“web项目”->“属性”->“生成”->勾选XML文件文件，如下如所示：

然后点击保存，即可在bin文件下面找到此文件，此文件即是controller中的方法的文件的集成，可以自行去看下。

四、修改App_Start文件夹下的SwaggerConfig文件

打开App_Start文件夹下的SwaggerConfig文件，在方法Register把注释过的c.IncludeXmlComments(GetXmlCommentsPath());放开，然后在此类中增加方法GetXmlCommentsPath来获取生成文件的位置即可。而下面的路径是上面生成的XML文件的路径，而放开注释的那段代码实现了对XMl文件的读取，方法的实现如下：

五、修改App_Start文件夹下的SwaggerNet文件，注释如下图的代码（我不知道为什么，如果不注释会报错的）：

注释代码如下：

以上就是实现自动化的全部步骤，在地址栏中输入地址如下：即可看到如下的界面：

过程就是这样的，可是做个小demo练习，我这个是直接在项目中添加啦。