next-openapi-gen

(โ˜… 189)

Automatically generate OpenAPI 3.0, 3.1, and 3.2 documentation from Next.js projects, with support for Zod schemas, TypeScript types, and reusable OpenAPI fragments.

Showing a partial file list โ€” download the zip above to see everything.

  • .changelogrc.cjs
  • .editorconfig
  • .gitattributes
  • .gitignore
  • .npmignore
  • AGENTS.md
  • CHANGELOG.md
  • commitlint.config.mts
  • CONTRIBUTING.md
  • instant-nav.rig.md
  • knip.mts
  • LICENSE.md
  • oxfmt.config.ts
  • oxlint.config.ts
  • package.json
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/tazo90/next-openapi-gen

Downloads the entire project code from GitHub to your computer.

cd next-openapi-gen

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
pnpm add -D next-openapi-gen

Type this command into your terminal and run it.

npm install --save-dev next-openapi-gen

Downloads and installs the libraries listed in package.json.

yarn add --dev next-openapi-gen

Type this command into your terminal and run it.

pnpm exec openapi-gen init

Type this command into your terminal and run it.

pnpm exec openapi-gen init --framework tanstack

Type this command into your terminal and run it.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation