OpenAPI JS
VSCode 插件,处理第三方工具的API文档; 插入对应的 JavaScript API 业务代码到当前文件。
功能特性
- 🔄 自动同步 OpenAPI 文档
- 📝 生成标准的 JavaScript API 请求代码
- 🎨 支持自定义代码模板
- 🔧 支持全局和工作区配置
- 🚀 快速插入 API 调用代码
支持的第三方 API 文档工具
使用前
配置第三方API工具认证信息
点击插件图标
点击项目设置
设置 API Token 、 项目 ID ; 可根据需要设置工作区/全局配置( 工作区优先级高于全局配置);
使用方法
打开需要api 请求的业务代码的文件; 如: api.js文件;
使用以下方式插入API 请求的业务代码;
打开侧边栏的 OpenAPI JS 视图
点击刷新按钮同步 API 文档
点击导出
支持配置
- API Token:用于访问 API 文档
- 项目 ID:指定项目标识
- 解析指定目录:输入需要解析的目录路径;如
api (根目录下的 api 目录)或 mobile/api (mobile目录下的 api 目录); 不支持指定多个文件夹
- Header 模板:API 文件的头部模板
快捷键
- 快速插入 API 调用代码
- windows:
Alt+F
- mac:
Option+F
APIFox 联动功能
icon按钮说明
刷新:同步 API 文档
导出:导出 API 请求文件
全部展开
全部折叠
最小化
| |