TourOptimizer REST Server (JOpt.TourOptimizer)

Deploy and operate JOpt.TourOptimizer as a reactive Spring WebFlux service (OpenAPI/Swagger)

This page documents the server-side of JOpt.TourOptimizer: a reactive Spring WebFlux application that exposes the optimizer via REST + OpenAPI (Swagger UI).

Overview

• Helpful links
• Why WebFlux + reactive is a great fit
• Swagger / OpenAPI
• Run locally and on platforms
• Fire & Forget / Database Mode
• Configuration overview

Helful links:

• Docker image: https://hub.docker.com/r/dnaevolutions/jopt_touroptimizer
• REST-Client documentation: /docs/learn-and-explore/rest/rest_client_touroptimizer
• Sandboxes: /docs/learn-and-explore/feature-guides/jopt-sandboxes
• Fire & Forget/ Database Mode: /docs/learn-and-explore/rest/touroptimizer-faf

Why WebFlux + reactive is a great fit

Optimization services are typically used in bursty, concurrent scenarios (batch planning, interactive UI runs, multiple teams, CI regression). The TourOptimizer REST server uses Spring WebFlux and reactive patterns to:

• keep the HTTP layer non-blocking (avoid thread starvation under load),
• support high concurrency for status/progress polling and long-running runs,
• integrate naturally with reactive event streams coming from the Java core (progress, warnings, errors).

The optimizer itself is compute-heavy, but WebFlux keeps the service layer scalable and responsive in real platform environments.

Swagger / OpenAPI

Swagger Endpoint UI

The Swagger/OpenAPI schema is derived from the snapshot model inside the Java library via annotations. This ensures that:

• the REST contract matches the SDK snapshot definition,
• generated clients stay aligned with the server,
• snapshots remain reproducible across environments.

Run locally (Docker)

docker run -d --rm --name jopt-touroptimizer \
  -p 8081:8081 \
  -e SPRING_PROFILES_ACTIVE=cors \
  dnaevolutions/jopt_touroptimizer:latest

• Swagger UI (typical): http://localhost:8081/swagger-ui/index.html
• OpenAPI JSON (typical): http://localhost:8081/v3/api-docs

If your REST client runs inside a Docker-based sandbox container, use http://host.docker.internal:8081 instead of http://localhost:8081.

Please also read our containter deployment help:

• JOpt TourOptimizer on Linux
• Docker Installation (Windows)
• JOpt TourOptimizer on Windows Platforms
• JOpt TourOptimizer on Apple Platforms (macOS)
• JOpt TourOptimizer on Kubernetes
• JOpt TourOptimizer – Enterprise Deployment with Terraform

Fire-and-forget mode

This page will describe asynchronous job submission patterns, polling, and optional persistence.

• Fire & Forget/ Database Mode: /docs/learn-and-explore/rest/touroptimizer-faf

Configuration overview

This section lists the configurable properties and groups them into:

• DNA/JOpt keys (product-specific behavior),
• Spring keys (standard Spring Boot / WebFlux / springdoc / actuator).

DNA / JOpt properties

Spring / WebFlux / springdoc properties

Container / runtime environment variables

Spring supports environment-variable mapping for many properties (e.g., SERVER_PORT can override server.port) depending on your deployment conventions.

References

• DockerHub: https://hub.docker.com/r/dnaevolutions/jopt_touroptimizer
• Self-hosting repo: https://github.com/DNA-Evolutions/Docker-REST-TourOptimizer