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

express-json-controller

v1.0.6

Published

JSON based controller and router mapping middleware, based on Express.

Downloads

2

Readme

Express JSON Controller

Express based Router-Controller middleware. This expects on a JSON file named 'route-map.json', where the routes are configured along with the controllers and methods. It also deals with security aspect of the application as well. In case you want to use header based tokens and a validator method for verifying, you simply have to provide

"secured": true

for the route-method. This is will make application to check for the headers and execute the validator before proceeding to the corresponding controller.

route-map.json:

route-map.json

{
    "name": "<APP-NAME>",
    "version": "1.0.1",
    "controllerPath": "controllers", // PATH OF THE CONTROLLER DIRECTORY    
    "basePath": "/api", // END-POINT BASE PATH
    "securityHeader": "Bearer",
    "routes":{
        "/healthcheck/:id":{
            "controller": "healthcheck", // CONTROLLER NAME
            "methods": {
                "GET": { // CONTROLLER METHOD
                    "methodId": "checkServerHealth", // EXPORTED METHOD NAME
                    "description": "Checking if the server is reachable or not."
                }
            }
        },
        "/auth/login":{
            "controller": "authentication",
            "bodyParser": true,
            "methods": {
                "POST": {
                    "secured": true, // FOR SECURITY VALIDATION
                    "methodId": "fbAuthVerify",
                    "description": "Authenticates a FB user and generates the token based on the USER UID."
                }
            }
        }
    }
}

Using as middleware

const expressJson = require('express-json-controller').default;
const express = require('express');
const authHandler = require('../helpers/auth-handler');
const app = express();
new expressJson(app, {basePath: './src'}, (middleWare)=> {
    middleWare.setSecurityHandler({'Bearer': authHandler.verifyToken}); // HEADER TO LOOK FOR + VALIDATOR METHOD
})

As of now it doesn't provide any editor support for edit and update the routes.