Specmatic Sample Client Application

BFF = Backend For Frontend, the API invoked by the HTTP calls in the client HTML page (Website UI).

This project contains the product API, which is used by a small ecommerce client application.

Here is the contract governing the interaction of the client with the product API.

The architecture diagram was created using the amazing free online SVG editor at Vectr.

How to run the application?

1. Build the project using : ./mvnw clean install
2. For unix platform, run the application using : ./mvnw spring-boot:run
3. For windows platform, run the application using : mvnw.cmd spring-boot:run

How to test the application?

1. Using maven: mvn clean test
2. Using docker:
   • Start Docker Desktop
   • Run the application ./mvnw spring-boot:run
   • Run the tests docker run --network host -v "$PWD/specmatic.yaml:/usr/src/app/specmatic.yaml" -v "$PWD/build/reports/specmatic:/usr/src/app/build/reports/specmatic" znsio/specmatic test --port=8090 --host=host.docker.internal