npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

swagger-yml-to-html

v1.0.5

Published

Convert Swagger/OpenAPI yml file into html

Downloads

3

Readme

swagger-yml-to-html

Convert Swagger *.yml files into a single html file.

Installation

Open Terminal/Command Prompt and run the following

npm i -g swagger-yml-to-html

# or if you prefer using yarn

yarn global add swagger-yml-to-html

Running the tool

Via CLI

Once installed, this tool is available as a command. To run it, use either swagger-2-html or swagger-to-html or s2h.

Available Options:

Usage: s2h [options]

Options:
  -V, --version                   output the version number
  -i, --input <input_file>        Input yml file path
  -o, --output <output_file>      Output html file path
  -t, --template <template_file>  Path to the template to use
  -h, --help                      display help for command

Programmatically

Add this module as a dependency in your project.

npm i swagger-yml-to-html

# or if you prefer using yarn

yarn add swagger-yml-to-html

Import the module and use the available methods:

// Import the module
const s2h = require('swagger-yml-to-html')
const { join } = require('path')

// Generate the html file
s2h.convertToHtml(join(__dirname, 'api-spec.yaml'), join(__dirname, 'output.yaml'), join(__dirname, 'template.html'))
// or just specify the input file. Output path will be same as input file directory and the default template will be used˝
s2h.convertToHtml(join(__dirname, 'api-spec.yaml'))

// Get the generated html file
s2h.getGeneratedHtml(join(__dirname, 'api-spec.yaml'), join(__dirname, 'template.html'))
// Or by using the default template
s2h.getGeneratedHtml(join(__dirname, 'api-spec.yaml'))

Template file

You can use custom template files if needed. The template file should have a placeholder ``, where the generated JSON file will be replaced to.

Sample template

<html>
    <head>
        <link
            rel="stylesheet"
            href="https://cdn.jsdelivr.net/npm/[email protected]/swagger-ui.css"
            integrity="sha256-DC+RBCRl4tlDpij6pievKfKyxlm8OaX38Sn5yGlmT1I="
            crossorigin="anonymous"
        />
        <script
            src="https://cdn.jsdelivr.net/npm/[email protected]/swagger-ui-bundle.js"
            integrity="sha256-UxKYBfPWl3Da6kCKrxYmmqMm+rit6ifogVaguCyISXQ="
            crossorigin="anonymous"
        ></script>
        <script>
            function render() {
                var ui = SwaggerUIBundle({
                    spec: '{{SWAGGER_JSON}}',
                    dom_id: '#swagger-ui',
                    defaultModelsExpandDepth: -1,
                    presets: [SwaggerUIBundle.presets.apis, SwaggerUIBundle.SwaggerUIStandalonePreset]
                })
            }
        </script>
    </head>

    <body onload="render()">
        <div id="swagger-ui"></div>
    </body>
</html>