Aplus vscode api generate
📢 Aplus 团队内部使用, 把swagger接口文档直接生成axios可用的接口和类型定义
功能
- 生成配置文件
- 根据配置文件生成接口和接口定义
- hooks支持
安装
- 打开 VS Code
- 转到扩展视图 (Ctrl+Shift+X)
- 搜索 "Aplus vscode api generate"
- 点击安装按钮
使用指南
基本使用
- 使用 快捷键 shift + command + p 打开vscode命令运行窗口,输入 Init Config,选中命令运行初始化生成配置文件
{
// 目标文件夹的路径
"apiPath": "src/subapp-bms/api/finance/test",
// 接口服务名
"serviceName": "/account",
// 是否需要生成hooks
"hooks": true,
// 自定义defPath的导入路径
"defPath": "@common/utils/http",
//生成hooks时的基础框架
"used":"vue"
}
- api-doc.json, 通过ApiFox导出的接口接口定义文件
- 使用 快捷键 shift + command + p 打开vscode命令运行窗口,输入 analysis api,选中命令运行即可
配置参数
| 参数名称 |
参数描述 |
参数类型 |
是否必须 |
默认值 |
| apiPath |
生成接口与类型定义的输出目录 |
string |
是 |
- |
| serviceName |
接口服务前缀(如网关服务路径) |
string |
是 |
- |
| defPath |
defHttp 的导入路径 |
string |
是 |
- |
| hooks |
是否生成 hooks |
boolean |
否 |
true |
| used |
生成 hooks 所用框架(vue/react) |
string |
否 |
vue |
| |