目录

一、问题描述： 

二、解决方法

分析程序输出日志

三、总结

        在 .NET 6.0 中，开发者可以使用 Swagger 来生成 Web API 的文档。然而，有时在启动 Swagger 时可能会遇到报错：“Failed to load API definition”。这个错误的原因可能有很多种，从配置问题到代码实现错误。本文将详细介绍该问题的解决方案。

一、问题描述： 

基于.Net6.0的WebApi 启动Swagger报错：“Failed to load API definition。即无法加载API定义。”，如下图所示：

二、解决方法

分析程序输出日志

错误信息： ERROR Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddleware - An unhandled exception has occurred while executing the request.
Swashbuckle.AspNetCore.SwaggerGen.SwaggerGeneratorException: Ambiguous HTTP method for action - Test.Controllers.TestController.GetPatientList (Test). Actions require an explicit HttpMethod binding for Swagger/OpenAPI 3.0
   at Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenerator.GenerateOper 

        根据上述日志，可以快速定义到哪个控制器，哪个方法或接口存在属性问题，根据上面日志显示，是控制器TestController中方法GetPatientList设置成公有（public）属性了，需要修改为private属性。

三、总结

当你在 .NET 6.0 Web API 项目中遇到 Swagger 报错：“Failed to load API definition”时，可以按照以下步骤进行排查和解决问题：

1. 检查项目文件：确保正确引用了 Swashbuckle.AspNetCore 包。
2. 验证 Startup 配置：确保在 Program.cs 文件中正确配置了 Swagger 服务和中间件。
3. 检查控制器和路由：确保控制器和路由定义正确，并正确使用了 HTTP 动作装饰器。
4. 检查 Swagger 路径：验证 SwaggerEndpoint 路径是否正确。
5. 处理注释和注解：确保 XML 注释配置正确，避免注解格式错误。
6. 解决端口冲突：确保项目端口没有冲突。
7. 配置 CORS：如果需要跨域访问，确保正确配置了 CORS。
8. 排查日志：以上步骤检查不到问题的情况可以从调试程序输出日志进行分析。

通过以上步骤，你应该能够解决大多数与 Swagger 相关的问题，使其正常加载和展示 API 定义。