swagger-to-vue v1.0.3

Swagger to Vue Services Generator

A command-line interface (CLI) tool that generates Vue services from Swagger or OpenAPI definition files.

Installation

This is a Node.js module available through the npm registry. Install it globally using npm:

npm install -g swagger-to-vue

It can be installed only on project scope using npm:

npm install swagger-to-vue

Usage

swagger-to-vue -i /path/to/swagger_or_openapi_file -o /path/to/vue_project [-ts, -js] [-t]

Where:

/path/to/swagger_or_openapi_file is the path to your Swagger or OpenAPI definition file (.json or .yaml).

/path/to/vue_project is the path to your Vue project directory where the services will be created.

This command generates an Vue service for each operation defined in the Swagger/OpenAPI file.

In case unit-test .test files need to be generated, adding -t or --test parameter will make the library to generate a spec file for each service generated.

The library also allows chosing between JavaScript and TypeScript flavors by passing the parameter -ts or -js when running.

Example

Let's say you have an OpenAPI definition file at /home/user/api.yaml, a Vue project at /home/user/my-vue-project, and want the services to be generated in TypeScript and with unit-tests. You can generate services using the following command:

swagger-to-vue -i /home/user/api.yaml -o /home/user/my_vue_project/services_directory -ts -t

After running this command, you will find a .ts file for each operation defined in api.yaml inside your Vue project directory, along with a test.service.ts file.

Note

This script assumes that the Swagger/OpenAPI file is well-formed and may not handle all edge cases. It's a good starting point, but for production usage, you would likely need to extend and harden this script according to your specific needs.

This script considers Axios as http dependency, and Jest as unit-test engine. Future versions may offer the possibility of chosing other options.

Changelog

• v1.0.3
  • Now when importing generated services on unit-test the extension (.js/.ts) is no longer used to avoid flag issues
• v1.0.2
  • Minor bug fixed
• v1.0.1
  • Minor bug fixed
• v1.0.0
  • Initial release