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.

파일 수가 많아 일부만 표시됩니다. 전체 파일은 위 다운로드 버튼으로 확인해 주세요.

  • .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

# 설치 가이드

1. 코드 내려받기
git clone https://github.com/tazo90/next-openapi-gen

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd next-openapi-gen

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.
pnpm add -D next-openapi-gen

이 명령어를 터미널에 그대로 입력해 실행하세요.

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

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

yarn add --dev next-openapi-gen

이 명령어를 터미널에 그대로 입력해 실행하세요.

pnpm exec openapi-gen init

이 명령어를 터미널에 그대로 입력해 실행하세요.

pnpm exec openapi-gen init --framework tanstack

이 명령어를 터미널에 그대로 입력해 실행하세요.

명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation