首页
/ NSwag v14.3.0 版本发布:全面升级与多项改进

NSwag v14.3.0 版本发布:全面升级与多项改进

2025-06-09 00:18:03作者:虞亚竹Luna

项目简介

NSwag 是一个强大的 .NET 工具集,用于生成、消费和可视化 OpenAPI/Swagger 规范。它能够从 .NET 代码生成 OpenAPI 规范,也能从 OpenAPI 规范生成客户端代码(支持 C# 和 TypeScript 等多种语言)。NSwag 还提供了 Swagger UI 和 ReDoc 的集成,使得 API 文档的展示和测试更加便捷。

核心更新内容

1. 基础库升级

本次发布的 v14.3.0 版本主要升级了底层依赖库 NJsonSchema 至 v11.2.0 版本。NJsonSchema 是 NSwag 的核心组件之一,负责 JSON Schema 的处理和转换。这一升级带来了更稳定和高效的 JSON Schema 处理能力。

2. Swagger UI 更新

新版本将 Swagger UI 升级到了 v5.20.2,这一更新带来了更现代化的界面和更好的用户体验。Swagger UI 是开发者与 API 交互的重要工具,新版本在性能和功能上都有所提升。

3. 代码生成改进

C# 客户端生成优化

  • 修复了参数爆炸问题,避免了不必要的参数扩展
  • 对于空请求体,现在会正确使用 FormUrlEncodedContent 而不是 StringContent
  • 增加了对原生记录类型(Native Records)的支持选项
  • 改进了编译器警告处理,减少了生成代码中的可能空引用警告

TypeScript 客户端改进

  • 优化了 dayjs 的导入方式,使用默认命名导入,提高了代码的可读性和一致性

4. 中间件增强

  • 改进了 SwaggerUiIndexMiddleware,使其能够更好地与 ReDocSettings 配合工作
  • 修复了 EnableTryItOut UI 选项的问题,确保了 API 测试功能的可用性

代码质量提升

本次版本在代码质量方面做了大量改进:

  1. 代码风格统一:采用了更一致的代码风格,包括使用模式匹配、复合赋值、简化集合初始化等现代 C# 特性
  2. 静态分析增强:添加了分析规则,并适当放宽了一些限制,提高了代码质量检查的准确性
  3. 性能优化:在适当的地方使用 TryGetValue() 和 Any() 代替其他方法,提升了代码执行效率
  4. 冗余清理:移除了不必要的成员初始化、未使用的 using 语句等冗余代码
  5. 类型安全:密封了私有/内部类型,并在适用的情况下将方法标记为静态,提高了类型安全性

构建系统升级

项目构建系统也进行了现代化改造:

  • 升级到 NUKE 9.0.4 构建系统,提高了构建效率和可靠性
  • 移除了对 .NET 6.0 的支持,专注于更新的 .NET 版本
  • 移除了过时的 Microsoft.Extensions.PlatformAbstractions 依赖

开发者体验改进

  1. 问题模板:添加了 GitHub 问题模板,使问题报告更加标准化和结构化
  2. 文档完善:为 ApiDescription 添加了继承文档,提高了代码的可读性和可维护性
  3. 媒体类型处理:修复了空请求体的媒体类型处理问题,确保了 API 调用的准确性

总结

NSwag v14.3.0 是一个注重细节改进和基础稳固的版本。它不仅升级了核心依赖,还通过大量代码质量改进提升了项目的整体健康度。对于 API 开发者来说,新版本提供了更可靠的代码生成能力、更完善的文档展示功能和更流畅的开发体验。

这些改进使得 NSwag 在 API 开发工具链中的地位更加稳固,无论是用于生成 API 文档还是客户端代码,都能提供更专业、更高效的支持。对于正在使用或考虑使用 NSwag 的团队来说,升级到这个版本将获得更稳定和现代化的开发体验。

登录后查看全文
热门项目推荐

热门内容推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
73
63
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.29 K
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
921
551
PaddleOCRPaddleOCR
飞桨多语言OCR工具包(实用超轻量OCR系统,支持80+种语言识别,提供数据标注与合成工具,支持服务器、移动端、嵌入式及IoT设备端的训练与部署) Awesome multilingual OCR toolkits based on PaddlePaddle (practical ultra lightweight OCR system, support 80+ languages recognition, provide data annotation and synthesis tools, support training and deployment among server, mobile, embedded and IoT devices)
Python
47
1
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
193
273
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
59
16