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

@codecontrol/node-gateway

v1.3.11

Published

A Simple NodeJS based proxy gateway

Downloads

9

Readme

node-gateway

A Simple NodeJS based Api Gateway

node-gateway is used to map your api calls through a single proxy. Instead creating different subdomains for your api's, you can gather them to a single endpoint with cors rules on top.

ex.

proxy.mydomain.com/users => https://userapi/users:2500 (internal api on the server)
proxy.mydomain.com/projects => https://projectapi/projects:2501 (internal api on the server)
proxy.mydomain.com/billing => https://commercial.api.com (external api)

Installation

  1. clone repository
  2. run npm install
  3. run the exampleGateway.js under the examples folder (node exampleGateway.js)

or

use the npm package, @codecontrol/node-gateway

npm i @codecontrol/node-gateway

Tests

Run npm test

Settings

Logger node-gateway uses Log4js for logging, see parameters from log4js (https://www.npmjs.com/package/log4js)

Server There are two different settings file. One for the actual configs, and another one for proxy routes.

example settings.json (under the config directory)

{
    "settings" : {
        "cors": {
            "allowedOrigin": "*",
            "allowCredentials": true,
            "allowedMethods": "GET, POST, DELETE, UPDATE, OPTIONS"
        },
        "server": {
            "port": 6010, 
            "noRouteMatchesErrorMessage": "No route matches the given address",
            "noWebsocketRouteMatchesErrorMessage": "No websocket route matches the given address",
            "generalErrorMessage": "node-gateway general error",
            "host": "127.0.0.1",
            "serviceName": "node-gateway"
        }, 
        "logger": {
            "logconfig" : { 
                    "appenders": {
                        "node-gateway": { 
                            "type": "console"
                        }
                    },
                    "categories": { 
                        "default": { 
                            "appenders": ["node-gateway"], 
                            "level": "ERROR" 
                        } 
                    }
            }
        }
    }

example of the routes.json (under the config directory)

{
    "rules": [
        {
            "prefix": ".*/users",
            "target": "https://userApi/users:4992"
        },
        {
            "prefix": ".*/organization",
            "target": "https://organizationApi/organization:4991"
        },
        {
            "prefix": ".*/organization/users",
            "target": "https://organizationApi/organization/users:4000"
        },
        {
            "prefix": ".*/notifications",
            "target": "wss://notificationAPI:4000"
        },
        
    ]
}

Usage

in your app file

var g = require('./index') (if you are on the root folder of this project)
//You can overwrite the settings with your own files if you wish, by using settings and routes params to configure method. 
//By default it uses the files under the config directory (see the npm version example under this one)
var config = g.configure() 
var server = g.server(config)
server = g.configureWebsockets(server,config) //Enable websockets, optional
g.listen(server)

or if you use the npm package

var g = require('@codecontrol/node-gateway')
var settings = require('./yourSettingsFile.json)
var routes = require('./yourRoutesFile.json)
var config = g.configure(settings, routes)
var server = g.server(config)
server = g.configureWebsockets(server,config) //Enable websockets, optional
g.listen(server)

To test your routes, just use the localhost:yourport/yourprefix, and see if it directs the call to your target. the following route on the example server settings will direct on the serverside, to https://userApi/users:4992 with the url localhost:6010/users

{
"prefix": ".*/users",
"target": "https://userApi/users:4992"
}