novelservice / novelrest

Microservice acting as public REST API for triggering the NovelWorker and fetching finished novels

Novel Rest

Description

The public API for the Novel Service. Allows to trigger the worker and fetch novels after they are finished

Dev Environment

Docker compose

In the project root create a file .env which contains variables needed for docker compose.

key	value	description
project_root	<path-to-repo>	The full path to the repository on the local file system without trailing slash

Start the dependencies declared in docker-compose.yml by running docker compose up -d
Then run the application inside your preferred IDE

Run configuration

Run with the system property variables set to below values by passing in the VM arguments with -D{key}={value}

key	value	description
NOVEL_SERVICE_CONFIG_FILE	<path-to-repo>/novel-service-config.yml	Config file location
NOVEL_FOLDER_KEY	<path-to-repo>/data	A folder to save novels. Used by this and novel-worker

novelrest's Issues

Adjust to novel worker change

worker send back jms message with result, instead of saving to DB

Change docker pulls badge to link to docker hub

Validate input url format

Add suffix to docker images

When publishing images as suffix with date and commit hash. Allows persistent artifacts, instead of overwriting old one