Installation

This guide will walk you through installing the Nx Plugin OpenAPI in your Nx workspace.

Prerequisites

Before installing the plugin, make sure you have:

The easiest way to install the plugin is using the nx add command:

nx add @lambda-solutions/nx-plugin-openapi

This command will:

You can customize the installation by passing options:

# Skip formatting after installation
nx add @lambda-solutions/nx-plugin-openapi --skipFormat=true

Option	Type	Default	Description
`skipFormat`	boolean	`false`	Skip formatting the workspace after installation

If you prefer manual installation, you can install the packages separately:

npm install --save-dev @lambda-solutions/nx-plugin-openapi

The plugin requires the OpenAPI Generator CLI as a peer dependency:

npm install --save-dev @openapitools/openapi-generator-cli

After installation, verify the plugin is working by checking the available executors:

nx list @lambda-solutions/nx-plugin-openapi

You should see output similar to:

@lambda-solutions/nx-plugin-openapi

Executors:
- generate-api : Generate API client code from OpenAPI specifications

Now that the plugin is installed, you can:

If you encounter issues, please file an issue on GitHub.