【.Net】ASP.NET项目使用Swagger生成API文档

前言

目前.net core项目自带swagger可以说是好用到爆，不仅可以清晰看到所有api接口，最主要的是可以直接进行调试，是不是很爽；但是对于.net framework项目目前没有自动继承swagger，可能调试起来还得借助其他工具，那么接下来就和大家一起将swagger集成到.net framework

创建.net framework项目

选中项目类型 ASP.NET Web应用程序(.NET Framework) 

 输入项目名称及选中位置

 选择Web API ，点击创建

默认API调试页面

 缺点：无法直接进行调试

集成Swagger

1、右键项目名称，点击“管理NuGet程序包” 

2、在搜索框中输入“Swashbuckle” ，选择Swashbuckle包后，点击安装

3、右键项目名称->属性->生成->输出->勾选“xml文档文件”

 

 4、在_Layout.cshtml文件中添加导航连接代码

<li>@Html.ActionLink("Swagger Help", "", "Swagger", new { area = "" }, null)</li>

5、修改SwaggerConfig.cs文件 

安装完成后，在文件夹App_Start自动生成一个配置文件 swagger.config。在这个文件中可以设置多版本控制、定义扩展功能、自定义显示ui的样式脚本、可以配置过滤、权限、为接口添加xml注释等，下面将演示如何添加xml注释，添加代码如下：

string path = string.Format("{0}/bin/OMS.Meeting.API.xml", System.AppDomain.CurrentDomain.BaseDirectory);
c.IncludeXmlComments(path);

 6、最终效果（点击swagger help导航连接进入） 

调用接口

展开任意一个api接口，点击“try it out”即可看到最终请求结果