Asp.net中使用Swagger

1. 在NuGet中安装Swagger的插件

在菜单栏中：工具 => NuGet包管理器 => 管理解决方案的NuGet程序包 => 浏览中搜索Swagger

需要下载的插件

2. 生成注释文档

右键项目根目录（这里是Demo），选择属性，在属性面板中进行下面操作

生成注释

3. 解决出现的问题

如果项目启动不了了，不要惊慌，注释掉/App_Start/SwaggerNet.cs文件中的这两行即可。

解决问题

到这里在浏览器中输入http://localhost:port/swagger可以看到它已经显示API了，但你写的注释还没有显示出来。还剩下面最后一步。

4. 在SwaggerConfig.cs中配置注释文件的路径

在类中加入如下代码：

// Add by Jun
protected static string GetXmlCommentsPath()
{
    // 这里的路径要修改为你生成的XML文件路径，在`步骤2`中可以看到
    return System.String.Format(@"{0}\bin\Demo.XML", System.AppDomain.CurrentDomain.BaseDirectory);
}

 c.IncludeXmlComments(GetXmlCommentsPath());

配置Xml文件的路径

自此就配置成功了！

5. 写注释

注释的格式如下：

/// <summary>
/// Show your name
/// </summary>
/// <param name="name">your name</param>
/// <returns></returns>
[System.Web.Http.HttpPost]
[System.Web.Http.Route("getname")]
public string Show(string name)
{
    return $"I know your name is {name}";
}

在浏览器中打开localhost:port/swagger就能看到效果了：

生成的效果