API-Gateway

Description

The Api-gateway was designed to help with channelling public routes to our internal (private) services. It was also designed to help with logging out and speedily verifying JWTs across all our services. View functional design here

Dependencies

• Redis

Setup instructions

• Create .env file (copy .env.example and tweak as necessary)
• Be careful to put in correct values for example, confirm that Redis credentials (REDIS_HOST, REDIS_PORT and REDIS_DATABASE) are same as Auth-Service
• Run composer install

How to add routes:

• Add your new routes in the file routes.map.json (or reoutes.map.dev.json)
• Make requests in the format

[api-gateway-url]/[service-name]/[end-point]

• send your GET or post parameters as you would to the underlying service

FAQs