Spot OSM Query Service (Dockerized)

This service is an integral component of the Spot application. Its primary functionality revolves around interpreting a graph's intermediate representation and, from there, building a corresponding Postgres query. The subsequent querying is run against the Spot OSM Postgres instance. The results are then returned in GeoJSON format, accompanied by relevant statistics.

Pre-Requisites

Ensure you've initiated and are running the Spot Postgres instance. This can be on your local machine or a remote setup.

Getting Started

1. Build the Docker container:

   docker build . -t osmapi

2. Run the container, ensuring that you replace the placeholder values for environment variables as necessary:

   docker run -p 5000:5000 \
   -e DATABASE_NAME='osmgermany' \
   -e DATABASE_USER='postgres' \
   -e DATABASE_PASSWORD='postgres' \
   -e DATABASE_HOST='host.docker.internal' \
   -e DATABASE_PORT='5432' \
   -e TABLE_VIEW='germany' \
   -e JWT_SECRET='your_jwt_secret' \
   osmapi

   Authentication is disabled by default. If you want to enable it, pass on the environment variable AUTH_ENABLED and set it to true.

API Endpoints

POST /run-osm-query

Input: Accepts POST requests with the intermediate representation (minimized version).

Output: Returns the result in GeoJSON format along with statistics.

Authentication

All endpoints require a valid JWT token for authentication. The token should be included in the Authorization header of each request in the following format:

Authorization: Bearer <your_jwt_token>

Architecture & Workflow

For a visual representation of how the service functions, please refer to the architectural diagram: