Automatic Express API argument checker and README generator
Rio has two main purposes:
- It allows you to specify arguments for an endpoint and automatically checks for them calling the endpoint.
- Automatically generates an API README of those endpoints.
Checkout the usage README to see how to add Rio to an existing Express API.
Install CLI with:
npm i -g ./Use the CLI command to generate API docs with:
rio init <path-to-api.js>Omitting the path will default it to ./api.js
You can view an example of an autogenerated API README here and the corresponding server code is available here.