为OpenAPI规范生成TypeScript客户端的轻量Node.js库
OpenAPI Typescript Codegen是一个轻量且稳健的Node.js库,能够根据OpenAPI规范生成TypeScript客户端。支持Fetch、Node-Fetch、Axios、Angular和XHR等多种HTTP客户端,兼容OpenAPI v2.0和v3.0规范,并可通过CLI、Node.js及NPX等工具生成。由于项目不再维护,建议迁移至@hey-api/openapi-ts。
OpenAPI TypeScript Codegen 是一个基于 OpenAPI 规范的 Node.js 库,该库的主要功能是自动生成 TypeScript 客户端代码。它为开发者提供了一种快速、轻量且与框架无关的解决方案,避免了在构建过程中使用 Java 编码生成工具。
在当前技术环境下,前端开发社区普遍青睐使用 OpenAPI 制定接口规范。然而,许多开发团队并不愿意在项目中引入繁重的 Java 生成工具。OpenAPI TypeScript Codegen 的出现,正是为了解决这一痛点,提供了一种更加轻量且高效的代码生成方式。
项目的目标是通过命令行工具(CLI)、Node.js 或者 NPX 支持 TypeScript 客户端的生成,并支持多种 HTTP 客户端,如 Fetch、Node-Fetch、Axios、Angular 和 XHR。
使用 npm 安装 openapi-typescript-codegen 非常简单,只需执行以下命令:
npm install openapi-typescript-codegen --save-dev
安装完成后,便可以通过 CLI 使用工具来快速生成代码。使用示例如下:
$ openapi --input ./spec.json --output ./generated