Skip to content

A simple middleware for displaying routes in an express application

License

Notifications You must be signed in to change notification settings

BolajiOlajide/koii

Repository files navigation

KOII

star this repo fork this repo npm Open Source Love Open Source Love

Koii is a simple ExpressJS middleware used to print all routes accessible in an application to the console on start.

Koii is inspired by Jackie and the fish

Install

npm install koii

Usage

To use Koii simply add it as a middleware in your express application. To do that, you need to first import Koii.

This can be done with requireJS or the ES6 import statements as shown below:

// we require this way because koii is currently exported as an esModule
const koii = require('koii');

OR

import koii from 'koii';

Once this is done, you can add the middleware with the statement

app.use(koii)

An example can be found in this github gist. Ensure you do this after all your route definitions, if not the middleware won't have access to the routes defined.

Read more about Koii here

Inspired by @danielb2's Blipp plugin for HapiJS