CLI Usage

Generate API clients using the ng-openapi command line interface.

Basic Commands

Direct Generation

ng-openapi -i swagger.json -o ./src/api

Configuration File

ng-openapi -c openapi.config.ts

Generate Subcommand

ng-openapi generate -i swagger.json -o ./src/api
ng-openapi gen -c openapi.config.ts  # Short alias

Common Options

Types Only

ng-openapi -i swagger.json -o ./src/api --types-only

String Dates

ng-openapi -i swagger.json -o ./src/api --date-type string

Combined Options

ng-openapi -i swagger.json -o ./src/api --types-only --date-type string

Configuration vs CLI

Simple Generation

Use CLI options for quick generation:

ng-openapi -i swagger.json -o ./src/api --date-type Date

Complex Generation

Use configuration file for advanced options:

// openapi.config.ts
const config: GeneratorConfig = {
    input: "./swagger.json",
    output: "./src/api",
    options: {
        dateType: "Date",
        customHeaders: { "X-API-Key": "key" },
        responseTypeMapping: { "application/pdf": "blob" },
    },
};

ng-openapi -c openapi.config.ts

Package.json Integration

Basic Scripts

{
    "scripts": {
        "generate": "ng-openapi -c openapi.config.ts",
        "build": "npm run generate && ng build"
    }
}

Multiple APIs

{
    "scripts": {
        "generate:users": "ng-openapi -i users-api.json -o ./src/api/users",
        "generate:orders": "ng-openapi -i orders-api.json -o ./src/api/orders",
        "generate:all": "npm run generate:users && npm run generate:orders"
    }
}

Help and Version

Get Help

ng-openapi --help
ng-openapi generate --help

Check Version

ng-openapi --version

Resources

• CLI Reference
• Configuration Options