Skip to content

Repository files navigation

This project adapts the core functionality of the Cimari library into a RESTful HTTP service built with Quarkus.

Important

Note, that this service is meant only for supported versions of Windows

Development

Run the application in development mode with live reload enabled:

./mvnw quarkus:dev

The application will start on:

http://localhost:8080

Quarkus Dev UI is available during development at:

http://localhost:8080/q/dev

You can change the port using

./mvnw quarkus:dev "-Dquarkus.http.port=<port>"

Building From Source

JVM Mode

To produce a self-contained executable JAR:

./mvnw clean package

Run the generated artifact using:

java -jar target/cimari-rest-runner.jar

Set your custom port with:

 java "-Dquarkus.http.port=<port>" -jar target/cimari-rest-runner.jar

Native Mode

Build a native executable using GraalVM or Mandrel:

./mvnw clean package -Dnative

Run the executable with:

./target/cimari-rest-runner

Set your custom port with:

./target/cimari-rest-runner "-Dquarkus.http.port=<port>"

API Documentation

OpenAPI specifications are exposed at:

/q/openapi?format=json

Swagger UI is enabled in development mode and available at:

/q/swagger-ui

Swagger UI is disabled in production builds by default.


Related Projects

About

This project adapts the Cimari codebase into a REST API service.

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages