JSPM

  • Created
  • Published
  • Downloads 3132
  • Score
    100M100P100Q119635F
  • License MIT

Automatically generate OpenAPI documentation for Next.js API

Package Exports

  • next-openapi-gen
  • next-openapi-gen/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (next-openapi-gen) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Next OpenAPI Gen

Next OpenAPI Gen is a library that automatically generates an openapi.json specification for your Next.js project. This tool scans your API routes, schemas, and models, and generates a complete OpenAPI definition.

Features

  • Auto-generates next.openapi.json in your project's root directory.
  • Scans API routes from app/api/ and includes them in the generated OpenAPI specification.
  • Scans schemas from the schemas/ directory and includes them in the OpenAPI components.

Installation

To install Next OpenAPI Gen, run:

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