如何通过NSwag在每次构建后生成并保存openapi.json至项目目录

方法一：使用NSwag.MSBuild集成（推荐，与构建流程深度绑定） #

1. 安装NSwag.MSBuild NuGet包
   在Package Manager Console执行：

   Install-Package NSwag.MSBuild
   

   或者直接在项目文件（.csproj）中添加：

   <PackageReference Include="NSwag.MSBuild" Version="14.0.0" PrivateAssets="all" />
   

   （注意替换为最新版本号）

2. 修改项目文件，添加构建后执行的MSBuild目标
   在.csproj文件末尾添加以下配置，指定生成逻辑和输出路径：

   <PropertyGroup>
     <!-- 自定义Swagger输出路径，可根据需求修改 -->
     <SwaggerOutputDir>$(ProjectDir)swagger\v1</SwaggerOutputDir>
     <SwaggerOutputPath>$(SwaggerOutputDir)\swagger.json</SwaggerOutputPath>
   </PropertyGroup>
   
   <Target Name="GenerateSwaggerAfterBuild" AfterTargets="Build">
     <!-- 创建输出目录（避免路径不存在报错） -->
     <MakeDir Directories="$(SwaggerOutputDir)" Condition="!Exists('$(SwaggerOutputDir)')" />
     <!-- 执行NSwag命令生成Swagger文档 -->
     <Exec Command="dotnet nswag webapi2swagger /assembly:$(OutputPath)$(AssemblyName).dll /output:$(SwaggerOutputPath) /runtime:Net7.0" />
   </Target>
   

   注意：根据你的项目.NET版本调整/runtime参数（如Net6.0、Net8.0），并确保$(OutputPath)$(AssemblyName).dll指向项目构建后的正确程序集路径。

方法二：使用NSwag CLI + 配置文件（灵活度更高） #

1. 全局安装NSwag CLI工具
   在命令行执行：

   dotnet tool install -g NSwag.ConsoleCore
   

2. 创建NSwag配置文件
   在项目根目录新建nswag.json，配置生成规则：

   {
     "runtime": "Net7.0",
     "documentGenerator": {
       "webApiToOpenApi": {
         "assemblyPaths": [
           "bin/Debug/net7.0/YourProjectName.dll"
         ],
         "output": "swagger/v1/swagger.json",
         "title": "你的API名称",
         "version": "v1",
         "defaultUrlTemplate": "{controller}/{action}/{id?}",
         "isAspNetCore": true
       }
     }
   }
   

   替换YourProjectName.dll为你的项目程序集名称，调整runtime和输出路径。

3. 绑定到项目构建流程
   在.csproj中添加构建后执行命令：

   <Target Name="RunNSwagCli" AfterTargets="Build">
     <Exec Command="nswag run nswag.json" />
   </Target>
   

注意事项 #

• 若项目有外部依赖，建议使用/project:$(ProjectPath)参数代替/assembly，让NSwag自动处理依赖加载：

  dotnet nswag webapi2swagger /project:$(ProjectPath) /output:$(SwaggerOutputPath) /runtime:Net7.0
  

• 构建时确保程序集已正确生成，若使用Release模式，需调整配置中的路径（如bin/Release/net7.0/）。
• 可通过添加Condition属性，让生成逻辑仅在特定构建配置下执行（如仅Debug模式）。

内容的提问来源于stack exchange，提问作者Phuong Duyen Huynh Ngoc