README.md

pagoPA Payment Options Service

Expose APIs that will be used by IO to retrieve the PDF receipts

---

Summary 📖

• Api Documentation 📖
• Technology Stack 📚
• Start Project Locally 🚀
  • Run locally with Docker
    • Prerequisites
    • Run docker container
  • Running the application in dev mode
• Develop Locally 💻
  • Prerequisites
  • Testing 🧪
    • Unit test
    • Integration test [WIP]
    • Performance test [WIP]
• Contributors 👥
  • Maintainers

---

Api Documentation 📖

See the OpenApi 3 here

In local env typing following url on browser for ui interface:

http://localhost:8080/q/swagger-ui

or that for yaml version http://localhost:8080/q/openapi

or that for json version http://localhost:8080/q/openapi?format=json

---

Technology Stack 📚

• Java 17 Runtime Environment GraalVM CE
• Quarkus
• quarkus-resteasy-reactive
• quarkus-smallrye-health
• quarkus-smallrye-openapi
• quarkus-resteasy-reactive-jackson
• reactor-netty
• lombok (provided)

---

Start Project Locally 🚀

Running the application in dev mode

You can run your application in dev mode that enables live coding using:

./mvnw compile quarkus:dev

NOTE: Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/.

Run locally with Docker

Prerequisites

• docker

Set environment variables

docker build -t pagopa-payments-option-service .

cp .env.example .env

and replace in .env with correct values

Run docker container

then type :

docker run -p 8080:8080 --env-file=./.env pagopa-payment-options-service

Develop Locally 💻

Prerequisites

• git
• maven (v3.9.3)
• jdk-17

Testing 🧪

Unit test

Typing mvn clean verify

Integration test [WIP]

• Run the application
• Install dependencies: yarn install
• Run the test: yarn test

Performance test [WIP]

---

Contributors 👥

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

Maintainers

See CODEOWNERS file