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

rio-express

v1.0.18

Published

Automatic Express API README generator

Downloads

3

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

wyattmufsonwyattmufson

Keywords

Readme

Rio

Automatic Express API argument checker and README generator

Actions Status Actions Status codecov tested with jest

Summary

Rio has two main purposes:

  1. It allows you to specify arguments for an endpoint and automatically checks for them calling the endpoint.
  2. Automatically generates an API README of those endpoints.

Usage

Checkout the usage README to see how to add Rio to an existing Express API.

The Rio CLI

Installation Guide

Install CLI with:

npm i -g ./

Using the CLI to generate a README

Use the CLI command to generate API docs with:

rio init <path-to-api.js>

Omitting the path will default it to ./api.js

Autogenerated API Docs

You can view an example of an autogenerated API README here and the corresponding server code is available here.