openapi-typescript-codegen

openapi-typescript-codegen

为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。

OpenAPITypeScriptOpenAPI Typescript CodegenAPI生成JSONGithub开源项目

项目介绍:OpenAPI TypeScript Codegen

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。

项目特点

  • 多种协议支持:支持 OpenAPI v2.0 和 v3.0 规范。
  • 文件格式:支持 JSON 和 YAML 格式的输入文件。
  • 生成灵活:允许通过不同方式生成,如 CLI、Node.js 环境和使用 NPX。
  • 请求中止能力:支持请求的中止,通过可取消的 Promise 模式实现。
  • 外部引用:通过 json-schema-ref-parser 支持外部引用。
  • 多种客户端:可为不同的 HTTP 客户端生成代码,包括 Fetch、Axios、Angular 等。
  • 多种配置选项:支持通过定制缩进、文件结构、命名后缀等进行个性化配置。

安装与使用

使用 npm 安装 openapi-typescript-codegen 非常简单,只需执行以下命令:

npm install openapi-typescript-codegen --save-dev

安装完成后,便可以通过 CLI 使用工具来快速生成代码。使用示例如下:

$ openapi --input ./spec.json --output ./generated

该命令将根据 spec.json 文件生成 TypeScript 客户端代码,并将其输出到 generated 文件夹中。通过其他命令参数,可以定制化生成的HTTP客户端、文件结构等。

未来发展

由于项目维护者时间有限,openapi-typescript-codegen 项目的维护已经停止,建议大家迁移至 [@hey-api/openapi-ts] 项目。新的项目将会专注于解决现有的重要问题,并继续对 OpenAPI 生成器进行维护和更新。

当前开源的所有请求和问题将在 2024 年 5 月 1 日之前被存档,所有相关软件包版本将在 NPM 上被弃用。因此,请广大用户尽快完成项目迁移。

致谢

感谢所有曾支持、下载和使用 OpenAPI TypeScript Codegen 的用户与开发者们,你们的支持是项目成长的重要动力!

总之,OpenAPI TypeScript Codegen 是一款功能强大的工具,帮助开发者们快速生成与 OpenAPI 规范相兼容的 TypeScript 客户端代码,适用于现代软件开发的各种需求。

编辑推荐精选

蛙蛙写作

蛙蛙写作

AI小说写作助手,一站式润色、改写、扩写

蛙蛙写作—国内先进的AI写作平台,涵盖小说、学术、社交媒体等多场景。提供续写、改写、润色等功能,助力创作者高效优化写作流程。界面简洁,功能全面,适合各类写作者提升内容品质和工作效率。

AI辅助写作AI工具蛙蛙写作AI写作工具学术助手办公助手营销助手AI助手
Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

下拉加载更多