ASP.NET WEBAPI 使用Swagger生成API文档
一、安装
新建一个没有身份验证的mvc项目 - SwaggerMvc5Demo,然后添加一个名为Remote(自定义)且包含基础读写(不想手写)的ApiController
![](https://images2018.cnblogs.com/blog/374636/201711/374636-20171128164511206-1959640418.png)
使用以下方法来添加 Swashbuckle:
- 从“程序包管理器控制台”窗口:Install-Package Swashbuckle -Version 5.6.0
- 从“管理 NuGet 程序包”对话框中:
- 右键单击“解决方案资源管理器” > “管理 NuGet 包”中的项目
- 将“包源”设置为“nuget.org”
- 在搜索框中输入“Swashbuckle”
- 从“浏览”选项卡中选择“Swashbuckle”包,然后单击“安装”
二、配置
1.项目属性->勾选生成xml文档文件
![](https://images2018.cnblogs.com/blog/374636/201711/374636-20171128164538206-2006272070.png)
2.添加导航链接
在_Layout.cshtml文件中添加代码
<li>@Html.ActionLink("Swagger Help", "", "Swagger", new { area = "" }, null)</li>
3.修改SwaggerConfig.cs文件
安装完成后,在文件夹App_Start自动生成一个配置文件 swagger.config。这里可以做多版本控制,定义扩展功能,自定义显示ui的样式脚本,可以配置过滤、权限等。
例如:
(1)为接口添加xml注释
string path = string.Format("{0}/bin/SwaggerMvc5Demo.XML", System.AppDomain.CurrentDomain.BaseDirectory);
c.IncludeXmlComments(path);
使用前
![](https://images2018.cnblogs.com/blog/374636/201711/374636-20171128164553581-358241639.png)
使用后
![](https://images2018.cnblogs.com/blog/374636/201711/374636-20171128164603487-698914376.png)
(2)使用特性 [Obsolete]
在config中 开启 c.IgnoreObsoleteProperties();
![](https://images2018.cnblogs.com/blog/374636/201711/374636-20171128164623284-1354065847.png)
三、调用
1.直接调用
只要输入参数id,即可调用,非常方便
![](https://images2018.cnblogs.com/blog/374636/201711/374636-20171128164640050-570196423.png)
2.AutoRest
AutoRest (https://github.com/Azure/AutoRest), 简单来说,就是一个EXE工具,可以根据Swagger的结构生成服务的客户端,这个客户端可以让你像调用本地方法一样调用服务,方法内部包装了Http请求。
扩展:ABP集成swagger
四、错误记录
swagger出现问题:not supported by swagger 2.0
一个controller中只能有一个HttpGet请求,多了就会报错。建议减少重载方法,将其他Get方法分开
如果在swagger.config中加上c.ResolveConflictingActions(apiDescriptions => apiDescriptions.FirstOrDefault());则会只显示第一个get方法
参考文章: