Registry / database / prisma-json-schema-generator

prisma-json-schema-generator

library5.1.5jsnpmunverified

Generates JSON Schema (draft-07) from a Prisma schema file. Current stable version 5.1.5. Released irregularly, maintained as part of the Prisma ecosystem. Differentiator: automatically converts Prisma models and enums to JSON Schema definitions, supporting relations, required fields, and custom schema IDs. Useful for API validation, documentation, or data exchange. Alternatives like typegraphql-prisma generate GraphQL schemas instead.

database devops

npm install prisma-json-schema-generator

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · PRISMA-JSON-SCHEMA

prisma-json-schema-generator

databasejavascriptv5.1.5

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.

default

✓ Not importable as JS module; used as Prisma generator.

Package is a CLI generator that runs via Prisma's generator mechanism. No API exports.

Installs package, configures Prisma generator, and generates JSON Schema files from Prisma schema.

// 1. Install // npm install prisma-json-schema-generator --save-dev // 2. Add to schema.prisma: generator jsonSchema { provider = "prisma-json-schema-generator" output = "./json-schema" } // 3. Run generation: // npx prisma generate

Debug

Known issues

gotchaDefault output path is ./json-schema. If not specified, files are written to current working directory.

fix

Set output option in schema.prisma: output = "./my-schemas"

affects: >=1.0.0

gotchaOptions like keepRelationScalarFields, includeRequiredFields must be strings "true" or "false", not booleans.

fix

Use keepRelationScalarFields = "true" (with quotes) in schema.prisma

affects: >=1.0.0

deprecatedKeepRelationFields option is deprecated in v5.0; use keepRelationScalarFields instead.

fix

Remove keepRelationFields and use keepRelationScalarFields

affects: >=5.0.0

breakingIn v4, the output changed from single file to multiple per model. Old imports break.

fix

Update any references from a single JSON file to individual model JSON files

affects: >=4.0.0

Errors

Common errors & fixes

Error: Could not find prisma generator. Please install prisma-json-schema-generator.

Generator not installed or not in devDependencies.

fix

Run: npm install prisma-json-schema-generator --save-dev

[prisma-json-schema-generator] Unknown option: keepRelationScalarFields

Option typo or old version without support.

fix

Ensure correct spelling and update to latest version. Option available since v4.

Upgrade

Version history

5.1.5latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

13 hits · last 30 days

node

Amazon

Bingbot

Resources

githubhttps://github.com/valentinpalkovic/prisma-json-schema-generator ↗

packageprisma-json-schema-generator ↗

homepagehttps://github.com/valentinpalkovic/prisma-json-schema-generator ↗