yapi-toolkit

Features

拉取 YAPI 文档并生成对应的 TypeScript 类型。

第一步: 配置你的 YAPI 信息

请在 .vscode/settings.json 文件中配置真实的 serverUrl 和 token：

{
  // ....其他配置
  "yapi-toolkit.serverUrl": "http://xx.xxx.xx.xx:10000/",
  "yapi-toolkit.token": "your_token_here"
}

获取方式分别为：

• YAPI 首页地址，如 http://xx.xxx.xx.xx:10000/
• YAPI 项目 -> 设置 -> token 配置 -> 复制 token （ 您可以参考更详细的文档：配置文档）

获取 token 需要加密，具体步骤为：

• 使用快捷键 ctrl + shift + p 唤出输入框，（mac 为 cmd + shift + p ）
• 输入 加密 ，找到 加密 YAPI token的选项，点击确认后把 token 复制进去，回车确定即可得到加密后的 token

第二步: 生成 TypeScript 类型

选中项目文件夹，右击菜单选择 "拉取 yapi 生成 type"，点击后底部状态栏即显示任务状态 。

第三步: 检查 src 目录下 service 文件夹

待生成成功后，生成文件结构如下

- service
  - model   // api 各个模块出入参声明的文件夹
    - login // 举个例子这里有登录模块
  - typings.d.ts //  typescript 声明的统一

输入 YAPI_login. 即可使用里面导出的类型

如果在使用过程中遇到问题，请检查以下事项：

• 确保 serverUrl 和 token 配置正确。
• 检查网络连接是否正常，确保能够访问 YAPI 服务器。