npm install --save jsdoc-to-json-schema

var toJsonSchema = require('jsdoc-to-json-schema'); // OPTION 1: generate a JSON schema for product.js and save it to disk toJsonSchema('./example/product.js', './example/product.schema.json'); // OPTION 2: generate a JSON schema and return it as an object toJsonSchema('./example/product.js').then(function(schema){ // do something with it }); // OPTION 3: generate a JSON schema, save it to disk and return it as an object toJsonSchema('./example/product.js', './example/product.schema.json').then(function(schema){ // do something with it });

var express = require('express'); var app = express(); var toJsonSchema = require('../lib/jsdoc-to-json-schema.js'); // create an express route app.get('/', function(req, res){ // pipe schema directly to the response stream toJsonSchema('./examples/person.js', res); }); // start the server listening on port 8080 app.listen(8080, function(){ console.log('Example app listening on port 8080'); });

/**  * @schema.name Person  * @schema.description This is an example Person object marked up with JSON schema tags to allow schema generation  */ var Person = { /**  * @schema.title Name  * @schema.description Please enter your full name  * @schema.type string  * @schema.maxLength 30  * @schema.minLength 1  * @schema.required true  */ name: '', /**  * @schema.title Job Title  * @schema.type string  */ jobTitle: '', /**  * @schema.title Telephone Number  * @schema.description Please enter telephone number including country code  * @schema.type string  * @schema.required true  */ telephone: '', /**  * @schema.type string  * @schema.required true  */ dateOfBirth: '' };

{ "name": "Person", "description": "This is an example Person object marked up with JSON schema tags to allow schema generation", "properties": { "name": { "title": "Name", "description": "Please enter your full name", "type": "string", "maxLength": 30, "minLength": 1, "required": true }, "jobTitle": { "title": "Job Title", "type": "string" }, "telephone": { "title": "Telephone Number", "description": "Please enter telephone number including country code", "type": "string", "required": true }, "dateOfBirth": { "type": "string", "required": true }, "address": { "type": "object" } } }

/**  * @schema.name Product  * @schema.description An example product marked up with json schema comments  */ function Product(){ } /**  * @schema.type array  * @schema.minItems 3  * @schema.maxItems 6  * @schema.required true  */ Product.prototype.types = function(){ }

{ "name": "Product", "description": "An example product marked up with json schema comments", "properties": { "types": { "type": "array", "minItems": 3, "maxItems": 6, "required": true } } }