首页
/ oRPC v0.25.0 发布:全局配置与OpenAPI增强

oRPC v0.25.0 发布:全局配置与OpenAPI增强

2025-06-25 06:16:29作者:魏献源Searcher

oRPC 是一个现代化的RPC框架,它通过TypeScript优先的方式简化了API开发流程。该框架提供了类型安全的合约定义、自动化的OpenAPI文档生成以及灵活的请求处理能力。在最新发布的v0.25.0版本中,oRPC引入了全局配置功能和OpenAPI文档生成的增强特性。

全局配置功能

新版本最显著的改进是引入了configGlobal函数,允许开发者自定义oRPC的默认行为。这个功能特别适合需要统一项目风格或适应特定架构要求的场景。

全局配置支持以下选项:

  • defaultMethod:设置默认HTTP方法(如GET、POST等)
  • defaultSuccessStatus:定义成功响应的默认HTTP状态码
  • defaultInputStructure:控制输入数据的结构格式('compact'或'expanded')
  • defaultOutputStructure:控制输出数据的结构格式('compact'或'expanded')

这种集中式的配置方式大大简化了项目级别的设置,避免了在每个路由中重复相同的配置。

OpenAPI文档增强

v0.25.0版本对OpenAPI文档生成功能进行了两项重要改进:

  1. 自定义成功描述:新增了successDescription选项,允许开发者为每个路由指定自定义的成功响应描述。这使得生成的API文档更加清晰和专业。

  2. 空请求体处理:框架现在能够正确处理没有请求体的API调用,同时改进了解码错误的处理机制,提升了开发体验。

其他改进

  • Zod集成优化:修复了嵌套描述在生成JSON Schema时不生效的问题,使得使用Zod进行复杂数据验证时文档更加准确。
  • 路由合并行为变更:现在重新定义路由时会进行展开合并(spread merge),这为路由扩展提供了更灵活的方式。

总结

oRPC v0.25.0通过引入全局配置和增强OpenAPI支持,进一步提升了开发效率和文档质量。这些改进使得框架更加适合企业级应用开发,特别是在需要严格API规范和统一风格的大型项目中。对于已经使用oRPC的团队,建议评估这些新特性如何能够优化现有代码结构;对于新用户,现在正是体验这个现代化RPC框架的好时机。

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