Getting started with provider data API (persistent)

This guide covers setting up and running the provider data API (persistent) locally.

Prerequisites

• Java 25 or later
• Gradle (recommend using the included Gradle wrapper)

Clone the repository

git clone https://github.com/ministryofjustice/laa-provider-data-platform.git
cd laa-provider-data-platform

Build from source

Build the application:

./gradlew clean build

Run integration tests:

./gradlew integrationTest

Run the application

Start the application locally:

./gradlew bootRun

Application endpoints

REST API documentation

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

Actuator endpoints

• http://localhost:8080/actuator
• http://localhost:8080/actuator/health

Run end-to-end tests

./gradlew :provider-data-e2e:e2eTest -Penv=local -Dauth.token=Dummy1

Build container image

./gradlew bootBuildImage

Libraries used

• Spring Boot Actuator - Application monitoring endpoints
• Spring Boot Web - REST API implementation
• Spring Data JPA - Database access abstraction
• Springdoc OpenAPI - OpenAPI documentation generation
• MapStruct - Object mapping between DTOs and entities