NSwag
NSwag 是一个通过 Swagger/OpenAPI 规范生成 .NET、TypeScript Web API 客户端和控制器的工具。它集成了 Swashbuckle、代码生成、校验等功能,支持从 API 文档生成 C#/TypeScript 客户端,或从客户端代码生成 API 控制器。NSwag 全链路打通前后端,是 API 开发的效率工具。

项目简介

NSwag 是一个通过 Swagger/OpenAPI 规范生成 .NET、TypeScript Web API 客户端和控制器的工具。它集成了 Swashbuckle、代码生成、校验等功能,支持从 API 文档生成 C#/TypeScript 客户端,或从客户端代码生成 API 控制器。NSwag 全链路打通前后端,是 API 开发的效率工具。

核心功能

代码生成
  • 生成C# API客户端
  • 生成TypeScript客户端
  • 生成API控制器
  • 生成DTO模型
Swagger集成
  • Swagger文档生成
  • 支持OpenAPI 3.0
  • 数据注解和XML注释
  • OData支持
工具集成
  • MSBuild集成
  • VS Web任务
  • 命令行工具
  • NSwagStudio GUI

使用方法

  1. 通过NuGet安装NSwag
  2. 配置Swagger文档生成
  3. 使用NSwagStudio生成客户端
  4. 在项目中自动生成代码

适用场景

  • 前后端API客户端自动生成
  • TypeScript前端对接
  • 微服务SDK生成
  • API文档和客户端一体化

项目地址

授权方式:免费 + 开源 (MIT)