0.1.16 • Published 2 years ago
vercel-openapi v0.1.16
vercel-openapi
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
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
0.1.14
2 years ago
0.1.15
2 years ago
0.1.16
2 years ago
0.1.11
2 years ago
0.1.12
2 years ago
0.1.13
2 years ago
0.1.12-0
2 years ago
0.1.9
2 years ago
0.1.7-0
3 years ago
0.1.6
3 years ago
0.1.4
3 years ago
0.1.3
3 years ago
0.1.5
3 years ago
0.0.20
3 years ago
0.1.0
3 years ago
0.1.2
3 years ago
0.1.1
3 years ago
0.0.11
3 years ago
0.0.12
3 years ago
0.0.13-post0
3 years ago
0.0.13
3 years ago
0.0.14
3 years ago
0.0.15
3 years ago
0.0.16
3 years ago
0.0.17
3 years ago
0.0.19
3 years ago
0.0.10
3 years ago
0.0.9
3 years ago
0.0.8
3 years ago
0.0.7
3 years ago
0.0.6
3 years ago
0.0.1
3 years ago
0.0.3
3 years ago
0.0.2
3 years ago
0.0.5
3 years ago
0.0.4
3 years ago
0.0.0
3 years ago