![](\"https://raw.githubusercontent.com/fjc0k/yapi-to-typescript/master/assets/logo.png\"){kind=logo}
\n\n \n
![](\"https://raw.githubusercontent.com/fjc0k/yapi-to-typescript/master/assets/dingtalk.jpg\")
\n\n\n\n- [预览](#预览)\n- [特性](#特性)\n- [环境要求](#环境要求)\n- [安装](#安装)\n- [使用](#使用)\n - [生成配置文件](#生成配置文件)\n - [修改配置文件](#修改配置文件)\n - [生成代码](#生成代码)\n- [配置](#配置)\n - [概论](#概论)\n - [配置项](#配置项)\n- [参与贡献](#参与贡献)\n- [许可](#许可)\n\n\n\n## 预览\n\n\n\n![](\"https://raw.githubusercontent.com/fjc0k/yapi-to-typescript/master/assets/preview.png?v=20190221\")
\n\n## 特性\n\n- 支持多服务器、多项目、多分类\n- 支持预处理接口信息\n- 可自定义类型或函数名称\n- 完整的注释\n- 支持生成 React Hooks 的请求代码\n- 支持参数路径\n- 支持上传文件\n- 支持生成 JavaScript 代码\n- 支持 Swagger\n\n## 环境要求\n\n- `Node >= 10.19.0`\n- `YApi >= 1.5.12`\n\n## 安装\n\n```bash\n# yarn\nyarn add yapi-to-typescript\n\n# 或者，npm\nnpm i yapi-to-typescript --save\n```\n\n## 使用\n\n`yapi-to-typescript` 基于当前目录下的 `ytt.config.{ts,js}` 配置文件进行相关操作。\n\n### 生成配置文件\n\n使用命令 `ytt init` 可在当前目录自动创建配置文件 `ytt.config.{ts,js}`，如果配置文件已存在，将会询问你是否覆盖：\n\n```bash\n# yarn\nyarn ytt init\n\n# 或者，npm\nnpx ytt init\n```\n\n### 修改配置文件\n\n打开当前目录下的 `ytt.config.{ts,js}` 配置文件，直接修改即可。[查看配置说明](http://fjc0k.github.io/yapi-to-typescript/interfaces/serverconfig.html)\n\n### 生成代码\n\n直接执行命令 `ytt` 即可抓取 `YApi` 的接口定义并生成相应的 `TypeScript`/`JavaScript` 代码：\n\n```bash\n# yarn\nyarn ytt\n\n# 或者，npm\nnpx ytt\n```\n\n## 配置\n\n### 概论\n\n从实质上而言，配置就是一个服务器列表，各个服务器又包含一个项目列表，各个项目下都有一个分类列表，其类型大致如此：\n\n```ts\ntype Servers = Array<{\n projects: Array<{\n categories: Array<{\n // ...\n }>\n }>\n}>\n\n// 配置实质是一个服务器列表\ntype Config = Servers\n```\n\n因此，你可分别在 `服务器级别`、`项目级别`、`分类级别` 进行相关配置，如果不同级别存在相同的配置项，低级别的配置项会覆盖高级别的配置项，也就是说：\n\n- 如果存在相同的配置项，`分类级别` 的配置会覆盖 `项目级别`、 `服务器级别` 的配置项；\n- 如果存在相同的配置项，`项目级别` 的配置会覆盖 `服务器级别` 的配置项。\n\n### 配置项\n\n具体配置项见：[API 文档](http://fjc0k.github.io/yapi-to-typescript/v3/interfaces/serverconfig.html)。\n\n## 参与贡献\n\n为避免无用功，功能新增或变更请提 issue 由维护者评估后再决定是否继续；功能修复以及经评估可行的功能新增或变更请提 PR。\n\n- 安装依赖：`yarn`\n- 运行测试：`yarn test`\n\n## 许可\n\nMIT (c) Jay Fong\n","readmeFilename":"README.md"}