bambudocker/gateway-service repository overview

⁠Bambu API Gateway

This is a derivative of the StrongLoop API Gateway.

⁠Basic features

The StrongLoop API Gateway's features include:

• HTTPS: Ensure all communication is done securely via HTTPS.
• OAuth 2.0 authentication and authorization: Authenticate client applications and authorize them to access protected endpoints with approval from resource owners.
• Rate limiting: control how many requests can be made within a given time period for identified api consumers.
• Reverse proxy: forward the requests to the server that hosts the api endpoint

⁠Installation

npm install

The command above will install the dependencies required.

However, there are some customizations done which will not allow this to work properly by just running the command. You will need to copy the folder loopback-component-oauth2 into the node_modules library to run locally.

This is not a problem in a server environment where docker is used. See the Dockerfile to see the setup. There is the command ADD loopback-component-oauth2 ./node_modules/loopback-component-oauth2 which copies the that folder into the node_modules as well.

⁠Running

Start the server

npm start

Open sample gateway dashboard app

https://localhost:3101/admin

⁠Using Typescript

npm install -g typescript #should be 3.03 and above
npm install -g tslint
# install in local repo will be better though

install ts-compile-on-save plugin in visial studio code, now it should auto compile to js

since most of the dev team is using .js, we will commit both .ts and .js file

⁠Option 1 Using submodule (better)

git submodule add [email protected]:bambudeveloper/base-microservices-submodule.git client-repo