YAPI TypeScript

English | A powerful editor extension for auto-generating TypeScript type definitions and API code from YAPI documentation. Supports VSCode, Cursor, VSCodium and other compatible editors.

中文 | 一个强大的编辑器插件，用于从 YAPI 接口文档自动生成 TypeScript 类型定义和 API 接口代码，提升前端开发效率。支持 VSCode、Cursor、VSCodium 等兼容编辑器。在编辑器中直接浏览 YAPI 接口文档，并一键生成标准化的 TypeScript 代码。

Keywords: YAPI, TypeScript, Code Generator, API Documentation, Type Generation, VSCode Extension, Swagger Alternative, Interface Generator, Frontend Development, API Client

插件名称: yapi-ts
GitHub 仓库: https://github.com/zhoujiandev/yapi2ts
Open VSX: https://open-vsx.org/extension/zhoujian/yapi-ts

功能演示

主要特性

• YAPI 集成: 支持多项目管理，实时同步接口文档。
• 智能代码生成:
  • 自动生成 TypeScript 类型定义（支持 JSON Schema 解析）。
  • 基于模板生成 API 请求代码（默认内置 Axios 模板，支持自定义 EJS 模板）。
  • 智能处理命名冲突，支持批量生成。
• 直观界面: 树形导航接口分类，表格展示接口详情，支持模糊搜索。
• 灵活模板: 内置常用模板，支持 EJS 自定义模板，满足个性化需求。
• 便捷操作: 一键复制生成代码，快速访问 YAPI 原文档。

快速开始

安装

在编辑器扩展市场搜索 yapi-ts 即可一键安装（支持所有基于 VS Code 内核的编辑器，如 VS Code、Cursor 等）。

使用流程

1. 配置项目: 在工作区设置 .vscode/settings.json 的 yapi2ts.projects 字段中配置 YAPI 项目。
2. 连接与授权: 选择配置的项目并点击“连接”。若未在配置中提供 Token，系统将提示在本地安全输入，并加密保存至系统 Keychain 中。
3. 生成代码: 勾选需要生成的接口，选择模板，点击对应生成按钮（“生成完整代码”、“仅类型定义”、“仅 API 代码”）生成代码。

文档

• 用户指南

  • 快速开始 (Quick Start) - 插件安装与基本配置。
  • 详细使用指南 (Usage Guide) - 项目管理、接口浏览与代码生成详解。
  • 模板系统 (Template System) - 模板语法参考与变量说明。
  • 常见问题 (FAQ) - 常见错误排查与解答。

• 开发者资源

  • 开发指南 (Development Guide) - 环境搭建、项目结构与API说明。
  • 贡献指南 (Contributing) - 拉取请求提交流程与规范。

许可证

本项目采用 MIT License 许可证。

如果这个插件对你有帮助，请给我们一个 Star！