Prox API Gateway

The purpose of this service is to provide routing capabilities to other services. The API gateway acts as a single entrypoint for multiple services.

Installation

After a git clone or download the project the following command must be executed once to initialize the projects.

Windows (CMD/PowerShell)

# Switch to project folder
cd .\prox-api-gateway\
# Execute initial build for git hooks...
.\mvnw.cmd clean test

Linux/MacOS (Bash/Terminal)

# Switch to project folder
cd prox-api-gateway/
# Execute initial build for git hooks...
./mvnw clean test

Executes the Maven default lifecycle up to the test phase. During the package phase, an executable JAR and the Docker image are created.

Local usage with docker

A Docker network named prox is required for the communication between services:

docker network create prox

Starts a Docker container based on the compose file and the image.

Powershell

$env:IMAGE='prox-api-gateway'; `
$env:TAG='latest'; `
docker-compose -f ./src/main/docker/docker-compose.yml up

Bash/Shell

export IMAGE="prox-api-gateway" &&
export TAG="latest" &&
docker-compose -f ./src/main/docker/docker-compose.yml up

Local usage in IntelliJ IDEA

For the necessary steps please look in Run/Debug in IntelliJ IDEA.

About the Team

This service is currently developed by members of the ArchiLab staff:

• Julian Lengelsen (@jlengelsen)
• Rudolf Grauberger (@rudolfgrauberger)