README.md

ubademy.gateway

Gateway for Ubademy

It handles and routes requests to different microservices.

For further information visit Ubademy Gateway

Deployed at: ubademy--gateway 🚀

Technologies

• FastAPI
• Poetry
• Docker
• Heroku

Architecture

├── main.py
├── app
│   ├── caller
│   │   ├── caller.py
│   │   ├── multi_service_caller.py
│   │   └── service_caller.py
│   └── router
│       ├── router.py
│       └── router_exception.py
└── tests

Installation

Dependencies:

• python3.9 and utils
• Docker
• Poetry

Once you have installed these tools, make will take care of the rest 😌

make install

Usage

Build

make build

Run the API locally

docker run -p 8000:8000 --env MICROSERVICES=<microservices_dict> GOOD_HEADERS=<good_headers_list>

Where:

• <microservices_dict> is a dictionary like: '{"service":"service_url"}'
• <good_headers_list> is a list like: '["good_header"]'

Run format, tests and linters

make checks

Access API Swagger

Once the API is running you can check all available endpoints at http://127.0.0.1:8000/docs#/