WEBAPI描述文档swagger

由于项目中需要开发WEBAPI但是考虑到，需要提供文档说明比较麻烦。所以考虑是否可以自动生成。

在网上找到两种方式。

1.微软自带的Microsoft.AspNet.WebApi.HelpPage  2.swagger 

测试使用微软的HelpPage后，同事让我看了Swagger后，果断使用Swagger。

Swagger效果如下

好了下来准备使用Swagger

在项目上点击右键 选择 管理NuGet程序包

查找Swagger 然后安装红色箭头所指的两项。

需要将Swagger.NET卸载。需要选择强制卸载。

删除Swagger相关的其他文件和文件夹，只保留下图所示的文件即可。

项目属性 勾选XML文档文件

    

修改SwaggerConfig文件

    //c.IncludeXmlComments(GetXmlCommentsPath());
    //设置接口描述xml路径地址
    c.IncludeXmlComments(string.Format("{0}/bin/WMS_API.XML", System.AppDomain.CurrentDomain.BaseDirectory));

 

运行项目 在地址栏中输入 localhost:7015/swagger 即可得到如下的显示效果