Open API / Swagger Spec Generation

[VinayaSathyanarayana]

Is there a way to generate Open API / Swagger Spec from Prisma Schema?

[ryands17]

@VinayaSathyanarayana 👋

Currently there is no way to generate an Open API / Swagger spec from a Prisma schema , but you can have a look at this project that you can take inspiration from to create a generator that creates an Open API spec :)

[alan345]

What about this lib? Is it going to do the job?
https://www.npmjs.com/package/prisma-json-schema-generator

[Dajcok]

prisma-json-schema-generator with json-schema-to-openapi-schema can do the job. I had to generate swagger schemas from my prisma models and if you are not using tsao or smth like that these two tools can do the job... After you generate your json you can do:

const fs = require('fs');
const convertSchema = require('json-schema-to-openapi-schema');
const YAML = require('js-yaml');
const path = require('path');

const jsonSchema = require('./schemas/json-schema.json');

const openApiSchema = convertSchema(jsonSchema);

const swaggerDocPath = path.join(__dirname, '../swagger.yaml');
const swaggerDoc = YAML.load(fs.readFileSync(swaggerDocPath, 'utf8'));

swaggerDoc.components = swaggerDoc.components || {};
swaggerDoc.components.schemas = { ...swaggerDoc.components.schemas, ...openApiSchema.definitions };

const finalSwaggerPath = path.join(__dirname, '../swagger.yaml');
fs.writeFileSync(finalSwaggerPath, YAML.dump(swaggerDoc));

Your question is more than a year old so if you figured smth out that can work better than what I did I would be more than grateful if you share...

[daaain]

You can generate the spec with Zenstack and its OpenAPI plugin: https://zenstack.dev/docs/reference/plugins/openapi

Since Zenstack's schema is a superset of Prisma, you should be able to use it as is.