dna-to-openapi
given holochain dna, generate a swagger / openapi spec file / static swagger-ui html documentation
usage
commandline
$
npm install -g @holochain/dna-to-openapi
$
dna-to-openapi -h
Usage dna-to-openapi [options]
Options:
-p, --path specify a path (otherwise ".")
-s, --spec generates an open-api spec file ("-" for stdout)
-d, --doc generates a static swagger-ui html doc ("-" for stdout)
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
Examples:
dna-to-openapi lints the given holo app / dna
dna-to-openapi --path <path> to specify a path (otherwise ".")
dna-to-openapi --spec <spec-file.json> generates an open-api spec
dna-to-openapi --doc <api-doc.html> generates static swagger-ui html doc
dna-to-openapi --spec <spec-file.json> does both
--doc <api-doc.html>
as a library
const dna = require('@holochain/dna-to-openapi')
const lintResults = dna.lint(dnaJsonObject, schemasObject)
if (lintResults.errors.length > 0) {
process.exit(1)
}
const specJson = dna.convert(dnaJsonObject, schemasObject)
const swaggerHtml = dna.genDocs(specJson)