1、安装
新建一个没有身份验证的mvc项目 - SwaggerMvc5Demo,而后添加一个名为Remote(自定义)且包含基础读写(不想手写)的ApiController
使用如下方法来添加 Swashbuckle:
- 从“程序包管理器控制台”窗口:Install-Package Swashbuckle -Version 5.6.0
- 从“管理 NuGet 程序包”对话框中:
- 右键单击“解决方案资源管理器” > “管理 NuGet 包”中的项目
- 将“包源”设置为“nuget.org”
- 在搜索框中输入“Swashbuckle”
- 从“浏览”选项卡中选择“Swashbuckle”包,而后单击“安装”
2、配置
1.项目属性->勾选生成xml文档文件
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);
使用前
使用后
(2)使用特性 [Obsolete]
在config中 开启 c.IgnoreObsoleteProperties();
3、调用
1.直接调用
只要输入参数id,便可调用,很是方便
2.AutoRest
扩展:ABP集成swagger
4、错误记录
swagger出现问题:not supported by swagger 2.0
参考文章: