/200Loc-gate

Plugin-based, small and simple api manager (gateway) - preview

Primary LanguageTypeScript

CircleCI codecov

Dependency Status

200LOC-GATE

200Loc-gate is a scalable, plugin based, open source API Middleware manager (API Gateway). Being deployed in front of your API servers uses defined plugins to process incoming calls.

Made to be small, simple and open. Use custom or build-in plugins to implement your logic for route processing and the client to manage them.

Based on Loopback framework, that makes it simple to use with various datasources. See loopback docs for more info.

NOTE! Solution is under development and is not ready.

  • implement monitoring system
  • add more standard plugins
  • add docker support
  • users and authentication
  • documentation
  • redis store

NOTE! Requires MongoDb installed for sample plugins

Quick start

# clone the repo
$ git clone https://github.com/byavv/200Loc-gate.git

# change into the repo directory
$ cd 200Loc-gate

# install 
$ npm install

# build
$ npm run build     

# run
$ npm start

Api management process:

screen

Development

Build

Development build (by default):

$ gulp build

Serve/watch

Start Gateway server on 3001 and Api explorer on 5601 in development mode:

$ gulp

Testing

$ gulp test