vercel-openapi

• vercel-openapi
• Usage
• Commands

Usage

$ npm install -g vercel-openapi
$ vercel-openapi COMMAND
running command...
$ vercel-openapi (--version)
vercel-openapi/0.1.16 android-arm64 node-v16.15.0
$ vercel-openapi --help [COMMAND]
USAGE
  $ vercel-openapi COMMAND
...

Commands

• vercel-openapi generate DIRECTORY
• vercel-openapi help [COMMAND]
• vercel-openapi scaffold

vercel-openapi generate DIRECTORY

Generates openapi.yaml for vercel serverless functions

USAGE
  $ vercel-openapi generate [DIRECTORY] [-d] [-h] [-o <value>] [-i <value>] [-e <value>] [--gitVersion] [-m
    CommonJS|AMD|System|UMD|ES6|ES2015|ES2020|ESNext|None]

FLAGS
  -d, --debug

  -e, --envVar=KEY=VALUE...
      Environment variables to have in scope for loading the endpoints.

  -h, --help
      Show CLI help.

  -i, --inputFile=<value>
      Defaults to [directory]/api/openapi.yaml

  -m, --moduleSystem=(CommonJS|AMD|System|UMD|ES6|ES2015|ES2020|ESNext|None)
      Sets the module system for loading the endpoints

      If you need more flexibility, you can set the TS_NODE_COMPILER_OPTIONS environment variable before invoking
      vercel-openapi. Note that the --envVar flag won't work for this option, as ts-node parses the environment
      variable before the cli starts.

  -o, --outputFile=<value>

  --gitVersion
      Append the short git hash to the end of the api version

DESCRIPTION
  Generates openapi.yaml for vercel serverless functions

EXAMPLES
  $ vercel-openapi generate . --output public/openapi.yaml

See code: dist/commands/generate.js

vercel-openapi help [COMMAND]

Display help for vercel-openapi.

USAGE
  $ vercel-openapi help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for vercel-openapi.

See code: @oclif/plugin-help

vercel-openapi scaffold

Generates a scaffolded openapi.yaml

USAGE
  $ vercel-openapi scaffold -t <value> -v <value> [-o <value>]

FLAGS
  -o, --outputFile=<value>
  -t, --title=<value>       (required)
  -v, --version=<value>     (required)

DESCRIPTION
  Generates a scaffolded openapi.yaml

EXAMPLES
  $ vercel-openapi scaffold --title FakeAPI --version 1.0.42

See code: dist/commands/scaffold.js