导言

tsoa-next 是原文本的继续 tsoa 在卢克·奥特里和贡献者在那里建立的稳定基础上继续发展。 它是一个框架,有一个综合的 OpenAPI 要构建的编译器 Node.js 使用 TypeScript。 。 。 。 它可以在运行时瞄准快递,快递,快递,快递和更多框架. tsoa-next 应用程序默认为类型安全,并且无缝地处理运行时间验证。

在以下指南中, tsoa 通常指的是: CLI 命令和基础架构 tsoa-next 继续。

目标

• TypeScript 作为您 API 唯一的真伪源的控制器和模型
• 一个有效的 OpenAPI (原为 Swagger光谱(2.0或3.0)来自您的控制器和模型,包括:
  • 路径(例如获取/用户)
  • 基于 TypeScript 接口(模型)
  • 参数/模型属性按要求标出或 TypeScript (例如我的财产? ) 字符串是可选的 OpenAPI 光谱)
  • jsDoc 支持对象描述( 多数其他元数据可以从 TypeScript 类型)
• 路由为中选择软件生成
  • Express, (中文(简体) ). Hapi,以及 Koa 目前支持的,其他中间软件可以使用简单的手提栏模板支持
  • 无缝运行时间验证

哲学

• 继续 TypeScript 可能时键入注释生成 API 元数据
• 如果常规类型说明不是表达元数据的适当方式,则使用装饰器
• 纯文本元数据使用jsdoc( 如端点描述)
• 尽量减少锅炉板
• 模型最好由接口(纯数据结构)来代表,但也可以由类别来代表
• 运行时间验证 tsoa-next 应尽量遵守生成的规格 OpenAPI 2/3计划描述。 验证逻辑上的任何差异在生成时通过日志警告得到澄清 OpenAPI 规格(OAS)和/或路线.
  • 请注意,通过授权 OpenAPI 3 您将不同验证逻辑的可能性最小化,因为 OpenAPI 3有更能表达的语法.

贡献者

暂无相关贡献者

页面历史

暂无最近变更历史