Digital Forms VI IRP VIPS Integration

This is the digitalforms level (root) of this project.

Built With

• Maven - Dependency Management
• JDK - Java Platform, Standard Edition 11 Development Kit
• Spring Boot - Framework to ease the bootstrapping and development of new Spring Applications
• git - Free and Open-Source distributed version control system
• Swagger - Open-Source software framework backed by a large ecosystem of tools that helps developers design, build, document, and consume RESTful Web services.

External Tools Used

• Postman - API Development Environment (Testing Documentation)

Technical Overview

Running the application

1. Using Eclipse or Spring Tool Suite 4 (STS4)

• Import as a Maven project from digitalforms (parent) level. Dependent API and Specification modules should load automatically.

• Create a run configuration for the parent POM:

  • clean install

• Launch the digitalforms-api from the Boot Dashboard or from a new run configuration with target of:

  • spring-boot:run

2. Using command line

From the digitalforms (parent) level, run:

mvn clean install

Then, from the digitalforms-api level, run:

mvn spring-boot:run

Note: This API uses submodules which should be updated before running the API:

 git submodule update --init 

Security

API is protected by basic auth which must be configured using environmental variables.

See digitalforms-api README.md, Environmental Variables

Actuator

See digitalforms-api README.md, API Services.

Splunk

Remote dependency

This API contains two shared dependencies, jag-vips-client, and jag-digitalforms-client. Both are used by other projects including DPS and Digital Forms, Reviews. Endpoint and user / password data must be set as environmental variables if running locally or set as Openshift secrets when in deployed in DEV/TEST/PROD environments.

For a complete listing of environmental variables see the API, README.md (https://github.com/bcgov/jag-rsbc-digital-forms-viirp-integration/blob/release/1.0/digitalforms-api/README.md)