Security News
NIST Misses 2024 Deadline to Clear NVD Backlog
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
bootprint-openapi
Advanced tools
Converts a openapi-definition into a static html page
I'm sorry to say that I won't be able to develop new features for this project in the near future. But: I will probably be able to discuss and merge pull-requests, and to publish new versions.
Please understand that I'm not using bootprint-openapi
myself at the moment and all I'm doing (or not doing
at the moment) is for other people to fill their needs. I have a limited time each week to work on open-source
projects and I want to work on some other projects.
This package contains a template, partials and styles for bootprint to convert OpenAPI-Specifications into a static HTML-page.
This package was formerly known as bootprint-swagger
and has been renamed, because
Swagger-Specification has been renamed to OpenAPI-Specification
In order to use bootprint-openapi
from the command line
you have to install bootprint
and bootprint-openapi
globally:
npm install -g bootprint
npm install -g bootprint-openapi
Check this out: You can now try out the new bootprint-openapi playground. Just paste a OpenAPI-specification and make it readable.
bootprint openapi http://petstore.swagger.io/v2/swagger.json target
The directory "target" should now contain a file index.html
and main.css
which contain a readable
form of the Swagger-Petstore-Example.
For details about command line parameters, please refer to the documentation of Bootprint
bootprint-openapi
is just a template-module for bootprint
. That means, it contains
LessCss-file, Handlebars-partials and a
preprocessor that converts
an OpenAPI-Specification into the JSON actually needed by the templates.
If you want to have a single HTML-file, not one HTML and one CSS, you can use substack's html-inline package to generate a self-cotnained file:
npm -g install html-inline
html-inline target/index.html
The does essentially the same, just in a the above command line, just in JavaScript (i.e. node
)
// Load bootprint
require('bootprint')
// Load bootprint-swagger
.load(require('bootprint-openapi'))
// Customize configuration, override any options
.merge({ /* Any other configuration */})
// Specify build source and target
.build('http://petstore.swagger.io/v2/swagger.json', 'target')
// Generate swagger-documentation into "target" directory
.generate()
.done(console.log)
The API of bootprint-openapi
consists of Handlebars-partials that can be overridden and
LessCss-Definitions, that can be adapted.
About 26 Handlebars partials are used to render this openapi-html-page. The following documentation is not final yet and there are a lot of partials without real documentation, but you may already have a look at it: The partials documentation describes the partials in use and the order in which they are called. You can override these partials in a Bootprint configuration file.
bootprint-openapi
is published under the MIT-license.
See for details.
Some of the example specs have been provided by contributors who opened issues on github,
those files are in the test/*
-directories.
For release notes, see CHANGELOG.md
See CONTRIBUTING.md.
FAQs
Converts a openapi-definition into a static html page
The npm package bootprint-openapi receives a total of 1,233 weekly downloads. As such, bootprint-openapi popularity was classified as popular.
We found that bootprint-openapi demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.