ASP.NET Web API 配置 Swagger

第一步： 在 NuGet 包管理器 中安装 Swashbuckle

第二步：修改 App_Start 文件夹中的 SwaggerConfig.cs 文件内容

// 第一个参数是版本，第二个参数是标题
c.SingleApiVersion("v1", "SwaggerDemo");

第三步：创建项目注释 XML 文档文件
右键单击 项目名称，单击 属性 ，勾选 XML 文档文件

第四步：修改 App_Start 文件夹中的 SwaggerConfig.cs 文件内容
释放代码 c.IncludeXmlComments(GetXmlCommentsPath());
将代码中的 GetXmlCommentsPath()
替换成 string.Format("{0}/bin/SwaggerDemo.XML", System.AppDomain.CurrentDomain.BaseDirectory)

c.IncludeXmlComments(string.Format("{0}/bin/SwaggerDemo.XML", System.AppDomain.CurrentDomain.BaseDirectory));

或者在 SwaggerConfig 类中定义方法 GetXmlCommentsPath

private static string GetXmlCommentsPath()
{
    return string.Format("{0}/bin/SwaggerDemo.XML", System.AppDomain.CurrentDomain.BaseDirectory);
}

这里的 /bin/SwaggerDemo.XML 是创建的项目注释 XML 文档文件 的路径地址

第五步：启动项目
地址：http://localhost:54216/swagger

问题处理：
1）没有添加 /// <summary> 注释的代码片段提示 缺少对公共可见类型或成员的 XML 注释
第一种解决办法：给代码片段添加 /// <summary> 注释

/// <summary>
/// 注释
/// </summary>

第二种解决办法：右键单击 项目名称，单击 属性 ，在 取消显示警告 后面输入 1591