https://github.com/mause/vercel-openapi
https://github.com/mause/vercel-openapi
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mause/vercel-openapi
- Owner: Mause
- Created: 2021-09-08T05:19:14.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-09T08:19:21.000Z (over 1 year ago)
- Last Synced: 2024-10-11T19:20:11.445Z (over 1 year ago)
- Language: TypeScript
- Size: 892 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# vercel-openapi
[](https://oclif.io)
[](https://npmjs.org/package/vercel-openapi)
[](https://npmjs.org/package/vercel-openapi)
[](https://github.com/Mause/vercel-openapi/blob/master/package.json)
[](https://nodei.co/npm/vercel-openapi/)
- [vercel-openapi](#vercel-openapi)
- [Usage](#usage)
- [Commands](#commands)
# Usage
```sh-session
$ 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-generate-directory)
- [`vercel-openapi help [COMMAND]`](#vercel-openapi-help-command)
- [`vercel-openapi scaffold`](#vercel-openapi-scaffold)
## `vercel-openapi generate DIRECTORY`
Generates openapi.yaml for vercel serverless functions
```
USAGE
$ vercel-openapi generate [DIRECTORY] [-d] [-h] [-o ] [-i ] [-e ] [--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=
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=
--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](https://github.com/Mause/vercel-openapi)_
## `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](https://github.com/oclif/plugin-help/blob/v5.1.12/src/commands/help.ts)_
## `vercel-openapi scaffold`
Generates a scaffolded openapi.yaml
```
USAGE
$ vercel-openapi scaffold -t -v [-o ]
FLAGS
-o, --outputFile=
-t, --title= (required)
-v, --version= (required)
DESCRIPTION
Generates a scaffolded openapi.yaml
EXAMPLES
$ vercel-openapi scaffold --title FakeAPI --version 1.0.42
```
_See code: [dist/commands/scaffold.js](https://github.com/Mause/vercel-openapi)_