swagger-converter-cli

📖 介绍

用于将 Swagger 的 json 对象转为 ts 文件定义

🔨 安装

npm install swagger-converter-cli

💡 使用示例

查看帮助文档命令：

npx swagger-converter

Usage:

    npx swagger-converter-init       : generate config file
    npx swagger-converter-ts         : generate ts file

创建配置文件命令：

npx swagger-converter-init

文件默认创建在根目录，命名为 swagger-converter.json（也可以不使用命令手动创建）:

{
    "hostname": "192.168.168.231",
    "port": 443,
    "path": "/api/swagger/doc.json",
    "method": "GET",
    "serviceDepts": "import { stringify } from \"qs\";import myRequest from \"@/utils/myRequest\";\nimport { RequestOptionsWithResponse } from \"umi-request\";",
    "template": "\n/**\n* {0}{1}\n* @param $data body 参数\n* @param $queryString url参数\n*/\nexport async function {2}({3}$data?:{4},$queryString?:{5}, options?: Omit<RequestOptionsWithResponse,'data'>) {\n    return myRequest.{6}<{7}>(`{8}` + '?' + stringify($queryString), {\n        data: $data,\n        ...options\n    });\n}\n",
    "createDir": "./service"
}

• protocol: 支持 https 和 http，非必选项，默认值 https

• hostname：json 请求 host 地址

• port：请求端口

• path：请求路由

• method：请求方式

• serviceDepts：service 方法定义可能使用第三方库，如 umi-request、Axios,那么在使用 template 时会用到他们，这里帮助 template 生成时，在文件顶部加入引用

• template：service 定义模板

  内部会执行 stringFormat，将 {x} 替换一些关键内容。

  • {0}：接口描述
  • {1}：path 参数描述
  • {2}：内部根据一些关键信息生成函数名称
  • {3}：path 参数
  • {4}：body 参数
  • {5}：url 参数
  • {6}：请求方式
  • {7}：返回值 ts 类型
  • {8}：请求 url，已注入 path 参数

• createDir：生成文件在项目中的位置（注意：每次生成文件时会清空该文件夹，所以不要与项目其他文件共用该文件夹）。

生成文件命令

npx swagger-converter-ts

注意事项

可能在执行 npx swagger-converter-ts 出现 prettier 相关问题，需要在 node_modules 中删除 prettier 相关的包文件即可。

Error: Cannot find module 'D:\XXX\XXX\XXX\node_modules\prettier-plugin-organize-imports\index.js'
    at t (D:\Arky\project\qllrh\node_modules\swagger-converter-cli\commands\converter.js:66:1834263)
    at D:\Arky\project\qllrh\node_modules\swagger-converter-cli\commands\converter.js:24:622393
    at Array.map (<anonymous>)
    at Object.<anonymous> (D:\Arky\project\qllrh\node_modules\swagger-converter-cli\commands\converter.js:24:622350)
    at Object.loadPlugins (D:\Arky\project\qllrh\node_modules\swagger-converter-cli\commands\converter.js:24:226859)
    at D:\Arky\project\qllrh\node_modules\swagger-converter-cli\commands\converter.js:24:622962
    at t.format (D:\Arky\project\qllrh\node_modules\swagger-converter-cli\commands\converter.js:3:365107)
    at t.format (D:\Arky\project\qllrh\node_modules\swagger-converter-cli\commands\converter.js:3:365107)
    at D:\Arky\project\qllrh\node_modules\swagger-converter-cli\commands\converter.js:3:373978
    at D:\Arky\project\qllrh\node_modules\swagger-converter-cli\commands\converter.js:3:372450 {
  code: 'MODULE_NOT_FOUND'
}

这时删除 node_modules 中 prettier-plugin-organize-imports 文件夹。