@huolala-tech/nad-cli

nad-cli ·

A CLI tool, can generate client code from an API service that has installed and enabled the nad-java-sdk.

Include

yarn add @huolala-tech/nad-cli -D

or

npm install @huolala-tech/nad-cli --save-dev

Usage

Usage: nad [Options] <URL>
       nad --config <Path>
       nad -c <Path>

Example: nad http://localhost:8080
         nad -t oc http://localhost:8080

Options:
  -t, --target <target>     Specify the output file format ("ts", "oc", "raw"), defaults to "ts".
  -o, --output <path>       Specify the output file path, defaults to stdout.
  -c, --config <path>       Path to configuration file. If specified, all other arguments will be ignored.
  -h, --help                Display this help message.

Config File

type Target = 'ts' | 'oc' | 'raw';

export interface ConfigFile {
  /**
   * Specify the output file format.
   * @default ts
   */
  target?: Target;

  /**
   * Specify the API definition file URL.
   * @required
   */
  url: string;

  /**
   * Specify the output file path.
   * @default stdout
   */
  output?: string;

  /**
   * Specify which APIs should be generated.
   * @default All
   */
  apis?: string[];

  /**
   * Define some special types to map to other types.
   */
  typeMapping?: Record<string, string>;
}