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

hapiman

v0.1.8

Published

Postman for hapi

Downloads

6

Readme

hapiman

API documentation generator (like lout) + API explorer (like postman) for hapi and joi.

Description

hapiman is a documentation generator for hapi servers, providing a human-readable guide for every endpoint using the route configuration and Joi validations.

In addition this will provide an API explorer for developers to play with the API.

Usage

hapiman depends on vision and inert, make sure you register them with hapi.

var Hapi = require('hapi');
var server = new Hapi.Server();

server.connection({ port: 80 });

server.register([require('vision'), require('inert'), { register: require('hapiman') }], function(err) {
});

server.start(function () {
     console.log('Server running at:', server.info.uri);
});

Parameters

There is nothing to pass atm as this is not the final release. But the idea is you being able to customise the template and also add auth to this.

Ignoring a route in documentation

If you want a specific route not to appear in hapiman's documentation, you have to set hapiman settings for this specific route to false.

Here is an example snippet of a route configuration :

{
  method: 'GET',
  path: '/my/route',
  config: {
    ...,
    plugins: {
      hapiman: false
    }
  }
}