@openapitools/openapi-generator-cli

OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (both 2.0 and 3.0 are supported). Please see OpenAPITools/openapi-generator

This project checks the maven repository once a day for a new version and will publish this new version automatically as an npm package.

Thanks openapitools.org for this awesome CLI!

Installation

There are several ways to install the package.

Global Mode

In global mode (ie, with -g or --global appended to the command), it installs the package as a global package. This means that you'll get the openapi-generator command available on your command line interface (CLI) as well.

# install the latest version of "openapi-generator-cli"
npm install @openapitools/openapi-generator-cli -g

# install a specific version of "openapi-generator-cli"
npm install @openapitools/[email protected] -g

After the installation has finished you can type for example:

# this shall print the correct version number
openapi-generator version

Package Mode

It is recommended to install the package as development dependency, because normally you only need this dependency during the development process. To do that you can type the following:

# install the latest version of "openapi-generator-cli"
npm install @openapitools/openapi-generator-cli -D

# install a specific version of "openapi-generator-cli"
npm install @openapitools/[email protected] -D

After the installation has finished you can add a script like this:

{
  "name": "my-cool-package",
  "version": "0.0.0",
  "scripts": {
    "my-awesome-script-name": "openapi-generator generate -i docs/openapi.yaml -g typescript-angular -o generated-sources/openapi --additional-properties=\"ngVersion=6.1.7\"",
  }
}

Usage Example

Mac/Linux:

openapi-generator generate -g ruby -i https://raw.githubusercontent.com/OpenAPITools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /var/tmp/ruby-client

Windows:

openapi-generator generate -g ruby -i https://raw.githubusercontent.com/OpenAPITools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o C:\temp\ruby-client

Further Documentation

Please refer to the official openapi-generator docs for more information about the possible arguments and a detailed usage manual of the command line interface.

You like the package?

Please leave a star.