Skip to content
| Marketplace
Sign in
Visual Studio Code>Snippets>Yapi-To-JSNew to Visual Studio Code? Get it now.
Yapi-To-JS

Yapi-To-JS

cupshe

|
193 installs
| (0) | Free
Yapi-To-JS
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Copied to clipboard
More Info

一.自动化生成前端接口 现状问题: 手动配置每个接口的命名,没有统一的接口名称规则;需要结合 Yapi 文档了解该接口的 header/入参/出参,操作成本高 解决方案:根据规范的 Yapi 接口格式,以 VScode 插件的形式,通过 VScode 插件命令和项目中已经存在的配置文件,生成各个模块对应的接口文件,以 js 文件的形式导出,避免手动命名和操作接口,形成统一的接口规范 二.使用方式

  1. 在 VScode 插件程序中搜索“Yapi To Js”,安装
  2. 在想要存放生成的 js 接口文件的地方,点击右键,会出现“Yapi interface Export“命令,点击该命令,会出现以下逻辑: a. 右键点击时,如果被点击文件夹下没有‘yapiConfig.json’文件,则默认生成,并提示‘配置文件有必传字段未配置’。此时,需要编辑配置文件,将用户名,密码写入。另需要配置projectIdList,该数组支持多个系统内容的全部/分组/单个接口导出 b. 如果用户本地已存在‘yapiConfig.json’配置文件,插件会将自带的配置文件与用户本地配置文件作对比,如果用户本地配置相对于插件自带配置少了某个参数,则插件会将用户缺少的那个配置参数写入到用户的配置文件中,用户的其他已配置内容不变。此功能是为了保持用户本地始终有最完整的配置内容,方便用户使用插件升级带来的更多功能(比如插件初期不支持catId导出模块下某个分组的接口,升级后则支持,但是用户本地配置文件需要有catIds配置参数,插件会默认给用户写入) c. 如果点击右键时,触发命令所在的文件夹下面没有叫‘modules’的文件夹,默认会生成 d. 导出的接口文件,会存放在 modules 文件夹下 e. js 文件名称默认为所导出模块的模块id

image

  • Contact us
  • Jobs
  • Privacy
  • Manage cookies
  • Terms of use
  • Trademarks
© 2025 Microsoft