jaouherk / proxy-gateway Goto Github PK

Proxy Gateway is an API gateway that hovers over microservices or serverless architecture. It is completely dissociated from the stack used for the other services. It secures and exposes your services with a complete control over all its functionality and behaviour.

This can be extended by creating or adding express middlewares.

This repository exposes an API interface to manage these routs. A frontend interface (initially in angular) will help you manage your gateway. Being built as a library will help you integrate it easily within any js interface.

• Proxy gateway for APIs of Microservices and Serverless architecture
• Interface to create mocks for the expected routes (Very handy for developers)
• Full control to the level of the methods used
• Developed with Express and Typescript
• API interface to manage it
• Integrates with frontend library
• Processes authenticated and public
• Included a Postman collection to start testing your API interface
• Output logs ready for easy parsing by logstash or Splunk
• Logging for major requests and incidents with levels of seriousness
• Logging uses tags to easily be fetched through logs grabber

After having installed Node globally, execute the following command:

$ git clone [email protected]:JaouherK/proxy-gateway.git
$ cd proxy-gateway
$ npm install

In your db server currently only mysql (but easily changes to any of the following: mariadb,sqlite,postgres,mssql) and create a database like gateway.

Open the config file within src folder and update the needed values

const defaultConfig = {
    port: 3232,  //the port that will be used to expose the app
    jsonLimit: '20mb',
    dialect:"mysql",
    host: "localhost",
    database: "gateway",
    username: "root",
    password: "password",
};

Execute the following command to start the docker container:

$ docker-compose up

This compose will start also a mysql container

Execute the following command to start the server:

$ yarn build
$ yarn start

For development purposes you can use this nodemon ignition

$ yarn start:watch

this will initialize the database and its tables if not exist. It will also expose initially the Manager and health check routes. Use the Postman collection to start creating your routing system.

All contributions welcome! Please see the contributor's guide& code of conduct

Please check security

MIT License