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

@studiohyperdrive/api-docs

v1.1.0

Published

Studio Hyperdrive API docs npm package

Downloads

16

Readme

Node.js API Docs

Simple Node.js package which exposes Swagger docs both in JSON and HTML.

Installation

$ npm install -S @studiohyperdrive/api-docs

Setup

app.use(docs({
    name: "my-api",
    version: "1.0.0",
    baseUrl: "/",
    path: "path/to/docs/folder/",
    basePath: "/v1",
    host: "studiohyperdrive.be",
    schemes: ["https", "http"],
    NODE_ENV: [
        "development"
    ]
}));

Configuration

  • name
    • Name of the API.
    • Defaults to the package.json name.
  • description
    • Description of the API.
    • Defaults to the package.json description.
  • version
    • Version of the API.
    • Defaults to the package.json version.
  • baseUrl
    • All routes will be prefixed with this value.
    • Defaults to "/".
  • path
    • Path (starting from the root) where all the docs can be found.
    • Package will search for Swagger docs in folder and nested folders.
  • NODE_ENV
    • Package exposes two routes only in specific NODE_ENV's.
  • host
    • host is the domain name or IP address (IPv4) of the host that serves the API.
    • Empty by default.
  • basePath
    • basePath is the URL prefix for all API paths, relative to the host root. It must start with a leading slash /.
    • Defaults to "/".
  • schemes
    • schemes are the transfer protocols used by the API. Swagger supports the http, https, and WebSocket schemes – ws and wss.
    • Defaults to "https".

Usage

Swagger docs will be available on these routes:

(Replace https://my-own-url.com with your domain. baseUrl is optional depending on your config.)