BackOffice External

Microservice with external APIs of PagoPA Backoffice

• BackOffice External
  • Api Documentation 📖
  • Technology Stack
  • Start Project Locally 🚀
    • Prerequisites
    • Run docker container
  • Develop Locally 💻
    • Prerequisites
    • Run the project
      • Local Environment
    • Spring Profiles
    • Testing 🧪
      • Unit testing
      • Integration testing
      • Performance testing
  • Contributors 👥
    • Maintainers

---

Api Documentation 📖

See the OpenApi 3 here.

---

Technology Stack

• Java 17
• Spring Boot
• Spring Web
• Hibernate
• JPA
• Maven 3

---

Start Project Locally 🚀

Prerequisites

• docker

Run docker container

from ./docker directory

sh ./run_docker.sh local

ℹ️ Note: for PagoPa ACR is required the login az acr login -n <acr-name>

---

Develop Locally 💻

Prerequisites

• git
• maven
• jdk-17

Run the project

Start the springboot application with this command:

mvn spring-boot:run -Dspring.profiles.active=local

Local Environment

👀 You need to put in your local environment some variables

VARIABLE	USAGE	DEFAULT VALUE
MONGODB_CONNECTION_URI	Connection string to the Backoffice MongoDB
MONGODB_NAME	Name of the Backoffice MongoDB	pagopaBackoffice
PAGOPA_APIM_API_CONFIG_API_KEY_PAGOPA	APIM Key to connect to Api-config

Spring Profiles

• local: to develop locally.
• default (no profile set): The application gets the properties from the environment (for Azure).

Testing 🧪

Unit testing

To run the Junit tests:

mvn clean verify

Integration testing

From ./integration-test/src

1. yarn install
2. yarn test

Performance testing

install k6 and then from ./performance-test/src

1. k6 run --env VARS=local.environment.json --env TEST_TYPE=./test-types/load.json main_scenario.js

---

Contributors 👥

Made with ❤️ by PagoPa S.p.A.

Maintainers

See CODEOWNERS file