本文介绍 ASP.NET 的 Swagger 部署，若您使用 ASP.NET Core 应用程序，请移步 ASP.NET Core Web API Swagger 官方文档：

https://docs.microsoft.com/zh-cn/aspnet/core/tutorials/first-web-api?view=aspnetcore-5.0&tabs=visual-studio

https://github.com/domaindrivendev/Swashbuckle.AspNetCore

安装

NuGet 中搜索安装 Swashbuckle，作者 Richard Morris

访问

http://您的域名/swagger

配置

显示描述

以将描述文件（xml）存放到项目的 bin 目录为例：

1. 打开项目属性，切换到“生成”选项卡

2. 在“配置”下拉框选择“所有配置”

3. 更改“输出路径”为：bin\

4. 勾选“XML 文档文件”：bin\******.xml，（默认以程序集名称命名）

5. 打开文件：App_Start/SwaggerConfig.cs

6. 取消注释：c.IncludeXmlComments(GetXmlCommentsPath());

7. 添加方法：

   public static string GetXmlCommentsPath()
   {
       return System.IO.Path.Combine(
           System.AppDomain.CurrentDomain.BaseDirectory,
           "bin",
           string.Format("{0}.xml", typeof(SwaggerConfig).Assembly.GetName().Name));
   }

   其中 Combine 方法的第 2 个参数是项目中存放 xml 描述文件的位置，第 3 个参数即以程序集名称作为文件名，与项目属性中配置一致。

如遇到以下错误，请检查第 2、3、4 步骤中的配置（Debug / Release）

500 : {"Message":"An error has occurred."} /swagger/docs/v1

使枚举类型按实际文本作为参数值（而非转成索引数字）

1. 打开文件：App_Start/SwaggerConfig.cs

2. 取消注释：c.DescribeAllEnumsAsStrings();