{"id":14979138,"url":"https://github.com/mause/vercel-openapi","last_synced_at":"2025-11-06T18:03:55.094Z","repository":{"id":36962197,"uuid":"404220327","full_name":"Mause/vercel-openapi","owner":"Mause","description":null,"archived":false,"fork":false,"pushed_at":"2024-10-09T08:19:21.000Z","size":913,"stargazers_count":3,"open_issues_count":21,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-11T19:20:11.445Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Mause.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-09-08T05:19:14.000Z","updated_at":"2022-06-15T09:16:31.000Z","dependencies_parsed_at":"2023-02-18T16:30:59.659Z","dependency_job_id":"7429b31d-6123-4bf0-ac94-b381e3527e31","html_url":"https://github.com/Mause/vercel-openapi","commit_stats":{"total_commits":349,"total_committers":7,"mean_commits":"49.857142857142854","dds":0.4269340974212035,"last_synced_commit":"f557b8549d937b0f3d07905ae5b4187e6c3f4a78"},"previous_names":[],"tags_count":40,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mause%2Fvercel-openapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mause%2Fvercel-openapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mause%2Fvercel-openapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mause%2Fvercel-openapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Mause","download_url":"https://codeload.github.com/Mause/vercel-openapi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219859166,"owners_count":16556037,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-24T13:59:20.568Z","updated_at":"2025-10-28T16:31:18.702Z","avatar_url":"https://github.com/Mause.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vercel-openapi\n\n[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)\n[![Version](https://img.shields.io/npm/v/vercel-openapi.svg)](https://npmjs.org/package/vercel-openapi)\n[![Downloads/week](https://img.shields.io/npm/dw/vercel-openapi.svg)](https://npmjs.org/package/vercel-openapi)\n[![License](https://img.shields.io/npm/l/vercel-openapi.svg)](https://github.com/Mause/vercel-openapi/blob/master/package.json)\n[![NPM](https://nodei.co/npm/vercel-openapi.png)](https://nodei.co/npm/vercel-openapi/)\n\n\u003c!-- toc --\u003e\n\n- [vercel-openapi](#vercel-openapi)\n- [Usage](#usage)\n- [Commands](#commands)\n\u003c!-- tocstop --\u003e\n\n# Usage\n\n\u003c!-- usage --\u003e\n\n```sh-session\n$ npm install -g vercel-openapi\n$ vercel-openapi COMMAND\nrunning command...\n$ vercel-openapi (--version)\nvercel-openapi/0.1.16 android-arm64 node-v16.15.0\n$ vercel-openapi --help [COMMAND]\nUSAGE\n  $ vercel-openapi COMMAND\n...\n```\n\n\u003c!-- usagestop --\u003e\n\n# Commands\n\n\u003c!-- commands --\u003e\n\n- [`vercel-openapi generate DIRECTORY`](#vercel-openapi-generate-directory)\n- [`vercel-openapi help [COMMAND]`](#vercel-openapi-help-command)\n- [`vercel-openapi scaffold`](#vercel-openapi-scaffold)\n\n## `vercel-openapi generate DIRECTORY`\n\nGenerates openapi.yaml for vercel serverless functions\n\n```\nUSAGE\n  $ vercel-openapi generate [DIRECTORY] [-d] [-h] [-o \u003cvalue\u003e] [-i \u003cvalue\u003e] [-e \u003cvalue\u003e] [--gitVersion] [-m\n    CommonJS|AMD|System|UMD|ES6|ES2015|ES2020|ESNext|None]\n\nFLAGS\n  -d, --debug\n\n  -e, --envVar=KEY=VALUE...\n      Environment variables to have in scope for loading the endpoints.\n\n  -h, --help\n      Show CLI help.\n\n  -i, --inputFile=\u003cvalue\u003e\n      Defaults to [directory]/api/openapi.yaml\n\n  -m, --moduleSystem=(CommonJS|AMD|System|UMD|ES6|ES2015|ES2020|ESNext|None)\n      Sets the module system for loading the endpoints\n\n      If you need more flexibility, you can set the TS_NODE_COMPILER_OPTIONS environment variable before invoking\n      vercel-openapi. Note that the --envVar flag won't work for this option, as ts-node parses the environment\n      variable before the cli starts.\n\n  -o, --outputFile=\u003cvalue\u003e\n\n  --gitVersion\n      Append the short git hash to the end of the api version\n\nDESCRIPTION\n  Generates openapi.yaml for vercel serverless functions\n\nEXAMPLES\n  $ vercel-openapi generate . --output public/openapi.yaml\n```\n\n_See code: [dist/commands/generate.js](https://github.com/Mause/vercel-openapi)_\n\n## `vercel-openapi help [COMMAND]`\n\nDisplay help for vercel-openapi.\n\n```\nUSAGE\n  $ vercel-openapi help [COMMAND] [-n]\n\nARGUMENTS\n  COMMAND  Command to show help for.\n\nFLAGS\n  -n, --nested-commands  Include all nested commands in the output.\n\nDESCRIPTION\n  Display help for vercel-openapi.\n```\n\n_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.12/src/commands/help.ts)_\n\n## `vercel-openapi scaffold`\n\nGenerates a scaffolded openapi.yaml\n\n```\nUSAGE\n  $ vercel-openapi scaffold -t \u003cvalue\u003e -v \u003cvalue\u003e [-o \u003cvalue\u003e]\n\nFLAGS\n  -o, --outputFile=\u003cvalue\u003e\n  -t, --title=\u003cvalue\u003e       (required)\n  -v, --version=\u003cvalue\u003e     (required)\n\nDESCRIPTION\n  Generates a scaffolded openapi.yaml\n\nEXAMPLES\n  $ vercel-openapi scaffold --title FakeAPI --version 1.0.42\n```\n\n_See code: [dist/commands/scaffold.js](https://github.com/Mause/vercel-openapi)_\n\n\u003c!-- commandsstop --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmause%2Fvercel-openapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmause%2Fvercel-openapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmause%2Fvercel-openapi/lists"}