https://github.com/john-doherty/express-json-schema
Adds express method to allow automatic generation of JSON schemas from a JS/JSON files containing @schema tags
https://github.com/john-doherty/express-json-schema
Last synced: about 2 months ago
JSON representation
Adds express method to allow automatic generation of JSON schemas from a JS/JSON files containing @schema tags
- Host: GitHub
- URL: https://github.com/john-doherty/express-json-schema
- Owner: john-doherty
- License: isc
- Created: 2016-05-04T22:42:19.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2018-02-03T11:18:37.000Z (over 8 years ago)
- Last Synced: 2025-10-27T16:56:02.145Z (7 months ago)
- Language: JavaScript
- Homepage:
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
# express-json-schema
[](https://www.npmjs.com/package/express-json-schema) [](https://www.linkedin.com/in/john-i-doherty) [](https://twitter.com/MrJohnDoherty)
Adds express `res.jsonSchema` method to allow automatic generation of JSON schemas from a JS/JSON files containing [@schema](https://github.com/john-doherty/jsdoc-to-json-schema) **@schema** tags
## Installation
```js
npm install --save express-json-schema
```
## Usage
```js
var app = require('express')(),
expJsonSchema = require('express-json-schema');
// add as middleware
app.use(expJsonSchema);
// use within route handler
app.get('/', function(req, res){
// return json schema for person.js file using new res.jsonSchema method
res.jsonSchema('./examples/person.js');
});
// start the server
app.listen(8080, function(){
console.log('Example app listening on port 8080');
});
```
### Example person.js
```js
/**
* @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: '',
/**
* @schema.type object
*/
address: {
}
};
```
### Example response
```js
{
"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"
}
}
}
```
## Supported tags
A list of supported tags can be viewed at [jsdoc-to-json-schema](https://github.com/john-doherty/jsdoc-to-json-schema#supported-json-schema-tags)
## License
[ISC License](LICENSE) © 2016 [John Doherty](https://twitter.com/CambridgeMVP)