ng-openapi-gen-cli: CLI for ng-openapi-gen

This project is a npm module that provides management operations of api services via ng-openapi-gen.

How to use it

In your project, run:

cd <your_angular_app_dir>
npm install ng-openapi-gen-cli --save-dev
node_modules/.bin/ng-openapi-gen-cli OPERATION -i PATH_TO_NG_OPENAPI_CLI_JSON -s SELECTION

Where:

• PATH_TO_NG_OPENAPI_CLI_JSON is the relative path to the ng-openapi-cli JSON file.
• OPERATION is the operation that should be executed. There are three operations permitted: generate, update and update-local.
• SELECTION is an optional argument, that lets you execute operations on a selected service. If your selection contains more than one service, you have to provide the flag multiple times. For example: -s service1 -s service2

Please, run the ng-openapi-gen-cli with the --help argument to view all available command line arguments.

Supported operations

These are the currently supported operations:

• generate: Generates the files of the local openapi descriptor via ng-openapi-gen.
• update: Updates the local openapi descriptor with the latest remote one and generates the files of the local openapi descriptor via ng-openapi-gen.
• local-update: Updates the local openapi descriptor with the latest local remote one and generates the files of the local openapi descriptor via ng-openapi-gen.

Configuration file

The api service configuration must be passed with a configuration file. The default configuration file name is ng-openapi-cli-gen.json, and should be placed on the root folder of your NodeJS project.

An accompanying JSON schema is also available, so the configuration file can be validated, and IDEs can autocomplete the file. If you have installed and saved the ng-openapi-gen-cli module in your node project, you can use a local copy of the JSON schema on ./node_modules/ng-openapi-gen-cli/ng-openapi-gen-cli-schema.json.

Configuration file reference

The supported properties in the JSON file are:

• defaultLocalUrl: The (default) local url endpoint of the openapi descriptor. This is needed for comparing local and remote json files and for updating the local file.
• defaultUrl: The (default) url endpoint of the openapi descriptor. This is needed for comparing local and remote json files and for updating the local file.
• name: The name of the service. This is just needed for reference and does not affect anything else.
• openapiGen: The relative location of the ng-openapi-gen configuration file, that describes how the files should be generated for the given service.

Configuration file example

The following is an example of a configuration file:

{
  "$schema": "./node_modules/ng-openapi-gen-cli/ng-openapi-gen-cli-schema.json",
  "configurations": [
    {
      "defaultLocalUrl": "http://localhost:8080",
      "defaultUrl": "http://url/to/openapi/v3/api-docs",
      "name": "auth",
      "openapiGen": "./path/to/ng-openapi-gen/file.json"
    }
  ]
}

Setting up a node script

Regardless if your Angular project was generated or is managed by Angular CLI, or you have started your project with some other seed (for example, using webpack directly), you can set up a scripts block.

To do so, create the ng-openapi-gen-cli.json configuration file and add the following scripts to your package.json:

{
  "scripts": {
    "openapi:generate": "ng-openapi-gen-cli generate -i ng-openapi-gen-cli.json",
    "openapi:update": "ng-openapi-gen-cli update -i ng-openapi-gen-cli.json",
    "openapi:update:local": "ng-openapi-gen-cli local-update -i ng-openapi-gen-cli.json"
  }
}