NSwag 项目教程

1. 项目目录结构及介绍

NSwag 是一个用于 .NET、ASP.NET Core 和 TypeScript 的 Swagger/OpenAPI 工具链。以下是 NSwag 项目的目录结构及其介绍：

NSwag/
├── assets/
├── build/
├── docs/
│   └── tutorials/
│       └── GenerateProxyClientWithCLI/
├── src/
├── .gitattributes
├── .gitignore
├── CHANGELOG.md
├── CONTRIBUTING.md
├── Directory.Build.props
├── LICENSE.md
├── README.md
├── azure-pipelines.yml
├── build.cmd
├── build.ps1
├── build.sh
└── global.json

目录结构介绍

• assets/: 存放项目相关的静态资源文件。
• build/: 包含项目的构建脚本和配置文件。
• docs/: 存放项目的文档，特别是教程文档。
  • tutorials/GenerateProxyClientWithCLI/: 包含生成代理客户端的 CLI 教程。
• src/: 项目的源代码目录，包含所有核心代码。
• .gitattributes: Git 属性文件，用于指定文件的 Git 行为。
• .gitignore: Git 忽略文件，指定哪些文件和目录不应被 Git 跟踪。
• CHANGELOG.md: 项目变更日志，记录每个版本的更改内容。
• CONTRIBUTING.md: 贡献指南，指导开发者如何为项目做出贡献。
• Directory.Build.props: MSBuild 属性文件，用于定义项目的构建属性。
• LICENSE.md: 项目的开源许可证文件。
• README.md: 项目的主 README 文件，包含项目的基本信息和使用说明。
• azure-pipelines.yml: Azure Pipelines 的配置文件，用于持续集成和持续部署。
• build.cmd: Windows 平台上的构建脚本。
• build.ps1: PowerShell 构建脚本。
• build.sh: Linux/macOS 平台上的构建脚本。
• global.json: .NET SDK 版本配置文件。

2. 项目的启动文件介绍

NSwag 项目的主要启动文件是 build.cmd、build.ps1 和 build.sh，这些文件分别用于在不同操作系统上执行项目的构建过程。

build.cmd

build.cmd 是 Windows 平台上的构建脚本，用于执行项目的构建任务。它通常会调用 build.ps1 或 build.sh 来完成实际的构建工作。

build.ps1

build.ps1 是 PowerShell 脚本，用于在 Windows 平台上执行项目的构建任务。它包含了详细的构建步骤和配置。

build.sh

build.sh 是 Linux/macOS 平台上的构建脚本，用于执行项目的构建任务。它与 build.ps1 类似，但适用于不同的操作系统环境。

3. 项目的配置文件介绍

NSwag 项目的配置文件主要包括 global.json、azure-pipelines.yml 和 Directory.Build.props。

global.json

global.json 文件用于指定项目使用的 .NET SDK 版本。它通常包含以下内容：

{
  "sdk": {
    "version": "5.0.100"
  }
}

azure-pipelines.yml

azure-pipelines.yml 是 Azure Pipelines 的配置文件，用于定义项目的持续集成和持续部署流程。它包含了构建、测试和发布等步骤的配置。

Directory.Build.props

Directory.Build.props 是 MSBuild 属性文件，用于定义项目的构建属性。它通常包含以下内容：

<Project>
  <PropertyGroup>
    <Version>1.0.0</Version>
    <Authors>Rico Suter</Authors>
    <Company>NSwag</Company>
  </PropertyGroup>
</Project>

这些配置文件共同确保了 NSwag 项目在不同环境下的正确构建和运行。