ryugames/rio

Automatic Express API README generator

Rio

Automatic Express API argument checker and README generator

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.

rio's Issues

Add `security` tag

Change default to 403