.NET 6模块式项目用NSwag生成OpenAPI文档遇工具缺失错误

错误翻译 #

为Test生成OpenAPI文档时出错：在清单文件中找不到名为"swagger"的命令工具。

解决步骤 #

• 检查并安装NSwag本地工具
  先查看项目根目录下的.config/dotnet-tools.json文件，确认是否包含NSwag相关配置。如果没有，执行以下命令安装NSwag CLI本地工具：

  dotnet tool install NSwagCLI --local
  

  安装完成后，工具清单文件会自动更新，添加NSwag的命令配置。

• 修正命令调用方式
  不要直接使用swagger命令，NSwag的正确调用命令是nswag。将生成脚本里的调用改为：

  dotnet tool run nswag <你的生成参数>
  

  或者直接使用本地工具的完整路径执行：

  ./.config/dotnet-tools/dotnet-nswag <你的生成参数>
  

• 确保Client类符合生成要求
  TestClient.cs中的请求方法必须是public修饰的，同时要添加明确的HTTP特性（比如[HttpGet("/api/test")]、[HttpPost("/api/test")]），NSwag依赖这些元数据才能生成正确的OpenAPI定义。

• 重置工具缓存
  如果上述操作后仍有问题，执行以下命令重置工具缓存：

  dotnet tool restore
  

内容的提问来源于stack exchange，提问作者Erlend Betting