根据 YApi 或 Swagger 的接口定义生成 TypeScript/JavaScript 的接口类型及其请求函数代码。
根据 YApi 或 Swagger 的接口定义生成 TypeScript/JavaScript 的接口类型及其请求函数代码。
钉钉扫码加入交流群:
Node >= 10.19.0
YApi >= 1.5.12
# yarn yarn add yapi-to-typescript或者,npm
npm i yapi-to-typescript --save
yapi-to-typescript基于当前目录下的
ytt.config.{ts,js}配置文件进行相关操作。
使用命令
ytt init可在当前目录自动创建配置文件
ytt.config.{ts,js},如果配置文件已存在,将会询问你是否覆盖:
# yarn yarn ytt init或者,npm
npx ytt init
打开当前目录下的
ytt.config.{ts,js}配置文件,直接修改即可。查看配置说明
直接执行命令
ytt即可抓取
YApi的接口定义并生成相应的
TypeScript/
JavaScript代码:
# yarn yarn ytt或者,npm
npx ytt
从实质上而言,配置就是一个服务器列表,各个服务器又包含一个项目列表,各个项目下都有一个分类列表,其类型大致如此:
type Servers = Array }> }>// 配置实质是一个服务器列表 type Config = Servers
因此,你可分别在
服务器级别、
项目级别、
分类级别进行相关配置,如果不同级别存在相同的配置项,低级别的配置项会覆盖高级别的配置项,也就是说:
分类级别的配置会覆盖
项目级别、
服务器级别的配置项;
项目级别的配置会覆盖
服务器级别的配置项。
具体配置项见:API 文档。
为避免无用功,功能新增或变更请提 issue 由维护者评估后再决定是否继续;功能修复以及经评估可行的功能新增或变更请提 PR。
yarn
yarn test
MIT (c) Jay Fong