使用 swagger2tsclient 转换代码

2023年5月15日 848点热度 1人点赞 0条评论
内容纲要

swagger2tsclient 并不是一个 Vue.js 相关的库,而是一个用于将 Swagger API 定义文件转换为 TypeScript 客户端代码的工具。您可以将生成的 TypeScript 客户端代码与 Vue.js 项目一起使用,以简化与后端 API 的交互。以下是如何在 Vue.js 项目中使用 swagger2tsclient 的步骤:

安装 swagger2tsclient npm 包:

npm install -g swagger2tsclient  

在 package.json 的 scripts 中加入:

"generate-client": "node_modules/.bin/nswag swagger2tsclient /input:%npm_package_devConfig_genClient_input% /output:%npm_package_devConfig_genClient_output%"

然后在 devConfig 中加入:

    "genClient": {
      "input": "http://localhost:666/swagger/swagger.json",
      "output": "src/client.ts"
    }
  • input 表示 swagger 的地址
  • output 表示生成的代码文件放置未知

然后执行命令将 swagger 文档生成 ts 代码。

npm run generate-client

或者直接执行命令,绕过 npm:

node_modules/.bin/nswag swagger2tsclient /input:'http://localhost:5000/swagger/v1/swagger.json' /output:'src/api/apclient.ts'

痴者工良

高级程序员劝退师

文章评论