Json Schema Static Docs
Description
Generates static documentation for humans based on the contents of JSON schema files (yml or json).
Support for JSON schema specification versions
Currently supports schema specified using the following specification versions: draft-06, draft-07 and draft-2019-09.
For complete documentation, including examples and supported keywords, see tomcollins.github.io/json-schema-static-docs.
Installation
npm install json-schema-static-docsUsage
See the docs for more details.
const JsonSchemaStaticDocs = require("json-schema-static-docs");
(async () => {
let jsonSchemaStaticDocs = new JsonSchemaStaticDocs({
inputPath: "./schema",
outputPath: "./docs",
ajvOptions: {
allowUnionTypes: true,
},
});
await jsonSchemaStaticDocs.generate();
console.log("Documents generated.");
})();