Skip to content

RootLinkFE/roothub-codegen

Repository files navigation

roothub-codegen

安装 RootHub VSCode 插件,使用 CodeGen 生成代码

Screenshots

1、类swagger-ui2.0模式查看接口文档,支持快捷复制、当前菜单搜索

2、预览生成的前端代码

3、api声明代码生产(包含入参注释),可单独、批量生产

4、支持 codesandbox 打开预览效果

5、自定义代码生成方法-在线编辑

6、图片文字提取、文本代码生产(字段英文翻译)、代码与接口文档匹配

开发说明文档

页面开发说明

本项目基于 Umi3.x,本地开发和 Umi开发没区别

RootHub VSCode插件开发说明

在 vscode-roothub 工程下,git submodule update 代码后,cd 进入 codegen 工程

然后 yarn start 启动项目(端口默认 3031)

.vscode/launch.json,运行 vscode extension 时添加启动环境变量 ,打开 CodeGen 会自动获取 http://localhost:3031 的地址内容。

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Run Extension",
      "type": "extensionHost",
      "request": "launch",
      "args": ["--extensionDevelopmentPath=${workspaceFolder}"],
      "outFiles": ["${workspaceFolder}/dist/**/*.js"],
      "preLaunchTask": "${defaultBuildTask}",
      // 启动环境变量
      "env": {
        "NODE_ENV": "development"
      }
    },
    {
      "name": "Extension Tests",
      "type": "extensionHost",
      "request": "launch",
      "args": [
        "--extensionDevelopmentPath=${workspaceFolder}",
        "--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
      ],
      "outFiles": [
        "${workspaceFolder}/out/**/*.js",
        "${workspaceFolder}/dist/**/*.js"
      ],
      "preLaunchTask": "tasks: watch-tests"
    }
  ]
}

常见问题汇总

  1. 获取失败常见于:输入的文档地址携带不正常后缀;文档在更新;插件更新需重新加载;swagger需要权限;本地使用了代理工具。
  2. 使用百度文字提取功能、翻译功能(百度翻译),需要在基础配置维护相关appid、screet、token。