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

hyped-swagger-middleware

v1.1.0

Published

Middleware component that hooks into hyped and uses its resources to generate a swagger schema file

Downloads

33

Readme

hyped-swagger-middleware

Autohost + Hyped middleware that can be wired up to an endpoint that will return a Swagger API doc spec file.

Warning: This example might be a little rough if you are starting from scratch. This is primarily to show how to integrate with an existing hyped + autohost solution.

Installation

npm install hyped-swagger-middleware --save

Usage

// index.js
var apiMetadata = {
    apiRoot: "/",
    version: "1.0.0",
    title: "Hyped API",
    description: "Our api",
    tos: "http://example.com/terms_of_service",
    contact: {
        name: "John Doe",
        email: "[email protected]",
        url: "http://example.com"
    },
    license: {
        name: "Commercial",
        url: "http://example.com/license"
    }
};

var autohost = require( "autohost" );
var hyped = require( "hyped" )( true, true );
var swaggerMiddleware = require( "hyped-swagger-middleware" );
var host = hyped.createHost( autohost, {
        // regular autohost configuration goes here
    },
    function() {
        host.http.middleware(
            "/api/swagger/:version/swagger.json",
            swaggerMiddleware( apiMetadata, hyped )
        );
        host.start();
    }
);

Example

Look at the example directory to see an example implementation. To run the example:

npm install
npm run example

Then in a new window:

curl http://localhost:8800/api/swagger/1/swagger.json