prisma-openapi

library1.6.0jsnpmunverified

A Prisma generator that automatically creates OpenAPI 3.1 specifications from your Prisma schema. Version 1.6.0 supports Prisma ^7.0.0 and generates OpenAPI schemas with type safety, relationship mapping, enum support, and customizable configuration. It also offers programmatic generation and JSDoc creation for TypeScript types. The package is actively maintained with monthly releases and includes a demo site.

database devops

npm install prisma-openapi

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · PRISMA-OPENAPI

prisma-openapi

databasejavascriptv1.6.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

generateOpenApiSchema

✓ import { generateOpenApiSchema } from 'prisma-openapi'

✗ import { generateOpenApiSchema } from 'prisma-openapi/src'

Default export is not available; use named export.

PrismaOpenApiGenerator

✓ import { PrismaOpenApiGenerator } from 'prisma-openapi'

✗ const { PrismaOpenApiGenerator } = require('prisma-openapi')

The package is ESM-only since v1.0.0; require() will fail.

GeneratorConfig

✓ import type { GeneratorConfig } from 'prisma-openapi'

Type import only, no runtime value.

Demonstrates both generator-based and programmatic usage to create OpenAPI schemas from Prisma models.

// Add to schema.prisma: // generator openapi { // provider = "prisma-openapi" // output = "./openapi" // } // Run: // npx prisma generate // Programmatic usage: import { generateOpenApiSchema } from 'prisma-openapi'; import { PrismaClient } from '@prisma/client'; const schema = generateOpenApiSchema({ models: ['User', 'Post'], title: 'My API', version: '1.0.0', }); console.log(JSON.stringify(schema, null, 2));

Debug

Known issues

breakingRequires Prisma ^7.0.0 – older versions are incompatible.

fix

Upgrade Prisma to 7.0.0 or later, or use an older version of prisma-openapi (not available).

affects: <1.0.0

deprecatedThe 'openapi' output directory is now default; explicit output path may be removed in future.

fix

Remove the output line from schema.prisma if using the default 'openapi' directory.

affects: >=1.4.0

gotchaGenerator does not support '@@map' attribute for table names – model names are used directly.

fix

Manually adjust schema names in generated OpenAPI output if needed.

affects: <=1.6.0

gotchaEnums without explicit values are exported as string type – not as enum OpenAPI object.

fix

Use `@openapi_enum` comment on enums to force OpenAPI enum schema.

affects: <=1.6.0

breakingMigrated from CommonJS to ESM in v1.0.0 – requires ESM in project.

fix

Set 'type': 'module' in package.json or use .mjs extension.

affects: >=1.0.0

gotchaGenerator does not auto-detect model relations that use a different field name (e.g., 'authorId' vs 'author').

fix

Use `@openapi_ignore` on the foreign key field or manually specify relations.

affects: <=1.6.0

Errors

Common errors & fixes

Cannot find module 'prisma-openapi' or its corresponding type declarations.

Package not installed or missing dependencies.

fix

Run `npm install -D prisma-openapi`. Note: peer dependency prisma@^7.0.0 must be installed.

Error: Generator 'prisma-openapi' not found.

Schema prisma file missing or incorrect generator name.

fix

Ensure schema.prisma contains: `generator openapi { provider = "prisma-openapi" }` and run `npx prisma generate`.

TypeError: generateOpenApiSchema is not a function

Default export mistake or wrong import path.

fix

Use named import: `import { generateOpenApiSchema } from 'prisma-openapi'`.

PrismaClientInitializationError: Invalid datasource. Please check your Prisma schema file.

Prisma version mismatch or broken schema.

fix

Ensure Prisma version >=7.0.0 and schema is valid. Run `npx prisma validate`.

Upgrade

Version history

1.6.0latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

7 hits · last 30 days

node

Resources

githubssh://git@github.com/nitzano/prisma-openapi ↗

packageprisma-openapi ↗

homepagehttps://github.com/nitzano/prisma-openapi#readme ↗