yapi-utils-vscode-ts
介绍
yapi 接口数据生成插件,可以生成 api 配置,formdata 内容以及 table columns 配置项,还支持定制化 git commit 提交信息和 git branch 名称。
请注意,该插件在不同情况下生成的结果内容可能不同,这主要是由 yapi 接口文档创建时所选择的数据生成方式以及类型标注方式所决定。插件会在迭代中尽可能兼容多种情况,但无法从根源上解决该问题,尽请谅解。
工具命令
命令 |
描述 |
yapi-gen-api |
yapi 根据 interfaceId 生成单个 Invoke api |
yapi-gen-api-batch |
yapi 根据 catId 批量生成 Invoke api |
yapi-gen-form-data |
yapi 生成表单对象数据 |
yapi-gen-bossui-table-columns |
yapi 生成 boss-ui 2.3.x 表格列数据 |
yapi-gen-bossdesign-table-columns |
yapi 生成 boss-bossdesign 表格列数据 |
git-commit-all-shield |
git 全量提交(工作区 & 暂存区) |
git-commit-stage-shield |
git 暂存区提交(仅包含暂存区) |
git-branch-shield |
创建 git 分支 |
插件配置
属性 |
描述 |
yapi-utils-vscode-ts.uid |
yapi 平台 uid |
yapi-utils-vscode-ts.token |
yapi 平台 token |
git-utils-vscode-ts.commit-template |
git 提交文字内容预设模板 |
git-utils-vscode-ts.custom-project-list |
git 提交前缀预设 -- 项目列表 |
git-utils-vscode-ts.custom-commands |
git 提交前缀预设 -- 命令列表 |
- yapi 相关工具使用前必须配置 yapi-utils-vscode-ts.uid 以及 yapi-utils-vscode-ts.token ,否则功能无法正常运行(git相关功能不依赖此配置项)。
- 单次配置有效周期约为 7 ~ 21 天一次(由 iuc + yapi 平台 token 过期规则限制)
Enjoy!
| |