ASP.NET Core 中使用 Swagger UI 进行本地测试的最佳实践

在 ASP.NET Core 开发过程中，Swagger UI 是一个非常实用的工具，它可以帮助开发者快速测试 API 接口。本文将详细介绍如何正确配置和使用 Swagger UI 进行本地开发测试。

默认的 Swagger UI 访问路径

当我们在 ASP.NET Core 项目中添加 Swagger 中间件后，默认情况下可以通过 /swagger 路径访问 Swagger UI 界面。这个路径是 Swagger 的约定俗成的标准访问点，开发者应该记住这个默认路径。

配置 launchSettings.json 自动打开 Swagger UI

为了提升开发效率，我们可以修改项目的启动配置，让应用在调试时自动打开 Swagger UI 页面。这可以通过修改 launchSettings.json 文件来实现：

1. 打开项目 Properties 文件夹下的 launchSettings.json 文件
2. 找到对应的启动配置文件
3. 添加或修改 launchUrl 属性为 "swagger"

示例配置如下：

{
  "profiles": {
    "YourProjectName": {
      "commandName": "Project",
      "dotnetRunMessages": true,
      "launchBrowser": true,
      "launchUrl": "swagger",
      "applicationUrl": "https://localhost:5001;http://localhost:5000",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    }
  }
}

为什么推荐这种配置方式

1. 提高开发效率：每次启动项目时自动打开 Swagger UI，省去了手动输入 URL 的步骤
2. 减少记忆负担：开发者不需要记住 Swagger UI 的具体访问路径
3. 标准化配置：团队中所有成员使用相同的开发环境配置，减少环境差异带来的问题

注意事项

1. 确保项目中已经正确添加了 Swagger 中间件
2. 在生产环境中应该禁用 Swagger UI，因为它会暴露 API 的详细信息
3. 如果修改了 Swagger 的默认路由前缀，需要相应调整 launchUrl 的值

通过以上配置，开发者可以更加高效地使用 Swagger UI 进行 API 测试和文档查看，提升开发体验和工作效率。