介绍

YApi to TypeScript(简称 ytt) 是一个代码生成工具,其可根据 YApiSwagger 的接口定义生成 TypeScript 或 JavaScript 的接口类型及其请求函数代码。

特性

  • 支持多服务器、多项目、多分类
  • 支持预处理接口信息
  • 可自定义类型或函数名称
  • 完整的注释
  • 支持生成 React Hooks 的请求代码
  • 支持参数路径
  • 支持上传文件
  • 支持生成 JavaScript 代码
  • 支持 Swagger

环境要求

首先得有 Node.js,并确保其版本 >= 10.19.0。同时:

  • 对于基于 YApi 的项目,要求 YApi 的版本必须 >= 1.5.12
  • 对于基于 Swagger 的项目,仅支持 Swagger 2OpenAPI 3

安装

选择你常用的包管理器将 yapi-to-typescript 加入项目依赖即可:

# npm
npm i yapi-to-typescript
# yarn
yarn add yapi-to-typescript
# pnpm
pnpm add yapi-to-typescript

如果你在国内且没有任何科学上网措施,上述安装过程可能会非常慢,推荐你使用 tbify,这个工具可以自动将 npm、yarn 等包管理工具连上国内的淘宝镜像,加速安装。

交流群

钉钉扫码加入交流群:

许可

MIT © Jay Fong