Schema to document generator, transform JSON schema to human readably form.
This tool is still on early development and is missing support for many important features. Please report any bugs you find, the code is only as good as the test cases.
- to easily get overview about your schemas
- support JSON schema draft 3 and 4
- command line interface (cli).
- support $ref
Schema2doc can be also used as a lib. Install module as local dependency
npm install git+https://github.com/gratex/schema2doc.git
OR
npm install git+ssh://[email protected]/gratex/schema2doc.git
than you can require desired rendered, available toCsv, toHtml and toRaw
const { toCsv, toHtml, toRaw } = require('schema2doc');
const schema = {
"type": "object",
"id": "Semaphore.POST.req.body.schema.json",
"$schema": "http://json-schema.org/draft-03/schema",
"additionalProperties": false,
"properties": {
"flagName": {
"type": [
"string",
"null"
],
"maxLength": 128,
"required": true,
"minLength": 1
},
"flagStatus": {
"type": "boolean",
"required": true
}
}
};
console.log(toCsv(schema));
console.log(toHtml(schema));
console.log(toRaw(schema));
If you want to print constraints, you can send options as second parameter (no other options supported yet)
var options = {
constraints : true
};
console.log(toRaw(schema, options));
You can also use the simple command line interface to process stdin and
stdout
npm install -g git+https://github.com/gratex/schema2doc.git
OR
npm install -g git+ssh://[email protected]/gratex/schema2doc.git
Usage:
schema2doc [-h|-r|-l|-c|-o <FILE>]
options:
-h print this help
-r print to raw format (default)
-l print to html format, table and simple css
-c print to csv format
-a print constraints (intervals, pattern)
-o <FILE> save output to a file (file will be created and overwritten)Installation is simple and only take few steps
-
clone repo
git clone https://github.com/gratex/schema2doc.git
-
move to newly cloned repo
-
install tool
npm install --global
-
ready to go
schema2doc
cat schema.json | schema2doc
{
"type": "object",
"id": "Semaphore.POST.req.body.schema.json",
"$schema": "http://json-schema.org/draft-03/schema",
"additionalProperties": false,
"properties": {
"flagName": {
"type": [
"string",
"null"
],
"maxLength": 128,
"required": true,
"minLength": 1
},
"flagStatus": {
"type": "boolean",
"required": true
}
}
}RQ/NN Field Type Format Desc
------ ------ ------ ------ ------
+- flagName string,null
++ flagStatus boolean<html>
<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'>
<head>
<style type='text/css'>table,th,td { margin: 0; padding: 0; border: 1px solid black;border-collapse: collapse;}table table {width: 100%;border: 0;}td {vertical-align:top;}td.name {font-weight:bold;color: blue; width: 150px;}
</style>
</head>
<body>
<table>
<tr>
<th>RQ/NN</th>
<th>Field</th>
<th>Type</th>
<th>Format</th>
<th>Desc</th>
</tr>
<tr>
<td class='name'>+-</td>
<td>flagName</td>
<td>string,null</td>
<td></td>
<td></td>
</tr>
<tr>
<td class='name'>++</td>
<td>flagStatus</td>
<td>boolean</td>
<td></td>
<td></td>
</tr>
</table>
</body>
</html>sep=;
RQ/NN;Field;Type;Format;Desc
+-;flagName;string,null;;
++;flagStatus;boolean;;- JSON schema draft 3 https://tools.ietf.org/html/draft-zyp-json-schema-03
Released under the MIT license