Using swagger2tsclient to Convert Code

2023年5月15日 1973点热度 1人点赞 0条评论
内容目录

swagger2tsclient is not a Vue.js related library, but a tool used to convert Swagger API definition files into TypeScript client code. You can use the generated TypeScript client code with Vue.js projects to simplify interactions with back-end APIs. Here are the steps to use swagger2tsclient in a Vue.js project:

Install the swagger2tsclient npm package:

npm install -g swagger2tsclient  

Add the following in the scripts section of package.json:

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

Then add the following in devConfig:

    "genClient": {
      "input": "http://localhost:666/swagger/swagger.json",
      "output": "src/client.ts"
    }
  • input refers to the address of the Swagger.
  • output refers to where the generated code file will be placed.

Then execute the command to generate TypeScript code from the Swagger document.

npm run generate-client

Alternatively, you can directly execute the command, bypassing npm:

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

痴者工良

高级程序员劝退师

文章评论