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.

⚠️ DEPRECATED ⚠️

The service has been deprecated as it's only purpose is forwarding API calls to a single service. We don't see any reason to use a spring-based service for this, rather simply use a reverse proxy.

A note on automatic formatting and linting

We partially use the Node.js runtime and npm to introduce a consistent code formatting in the whole project. Doing so Maven will download and install Node and npm into the project directory using the frontend-maven-plugin and runs npm ci. This will install scripts using husky into your git hooks. We understand that this process might sound malicious to you, and therefore you are free to disable the behaviour by explicitly disabling the maven profile node. Doing so will skip the installation of node, npm and therefore will prevent installing the git hooks. However, we strongly encourage you to adapt the process if you plan to contribute to this project as it keeps our code-base clean and in a consistent style without any additional effort.

Installation

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

Windows (CMD/PowerShell)

cd .\prox-api-gateway\
# Execute initial build
.\mvnw.cmd clean test

Linux/MacOS (Bash/Terminal)

cd prox-api-gateway/
# Execute initial build
./mvnw clean test

Executes the Maven default lifecycle up to the test phase.

Building

./mvnw clean package

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

About the Team

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

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

Development

Please consider our contributing guidelines.

Commit Messages

The commit messages SHOULD adhere to the Conventional Commits specification. This repository is also Commitizen-friendly. You can use Commitizen seamless in this repository.

Perform a release

In general releases are done by pushing a git tag which conforms to SemVer specification. We prefix those tags with a v, so the tag itself MUST follow the pattern vMAJOR.MINOR.PATCH. A label is not used.

The simplest way to perform a release is by relying on our standard-version configuration. If you are ready to perform a release simply call

$ npx standard-version
# or
$ npm run release

This will analyze the last commits since the last release, determine the new version, generate a changelog and create a git tag for you. Next up you will need to push the tag and version bumped files, our release pipeline will take care of the rest.

$ git push --follow-tags origin main