hmpps-jobs-board-integration-api

About

The Match Jobs and Manage Applications - Jobs Board Integration service is conceived as an independent service providing asynchronous communication with other services. For now, the only service it will be integrated with will be the Meganexus Jobs Board.

• The product page on Developer Portal: Match Jobs and Manage Applications
• The high level design on Confluence: Match Jobs & Manage Applications - HLD

Team

This integration service is developed and supported by Education Skills & Work team. They can be contacted via #education-skills-work-employment-dev on Slack.

Healthiness

The integration service has a /health endpoint which indicates the service is up and running.

Instructions

Running the application locally

• Run with the Spring profile dev on local
  • Set active profile via this environmental variable spring.profiles.active=dev or SPRING_PROFILES_ACTIVE=dev
• Run with the Spring profile local group on local
  • Set active profile to local: spring.profiles.active=local or SPRING_PROFILES_ACTIVE=local
  • The local group will utilise localstack for Integration features with message queue (SQS)
• API Spec:
  • Goto http://localhost:8080/swagger-ui/index.html to explore the OpenAPI specifications
• Checking endpoints
  • Goto http://localhost:8080/health to check the service is up and running

Running with Docker

docker compose pull && docker compose up -d

will build the application and run it and HMPPS Auth within a local docker instance.

Running the application in Intellij

docker compose pull && docker compose up --scale hmpps-jobs-board-integration-api=0 -d

will just start a docker instance of HMPPS Auth and localstack. The application should then be started with a dev or local active profile in Intellij.

• supply required env var, e.g.
  • spring.profiles.active=dev
  • SPRING_PROFILES_ACTIVE=local