Skip to content

Latest commit

 

History

History
72 lines (56 loc) · 2.21 KB

README.md

File metadata and controls

72 lines (56 loc) · 2.21 KB
Raw

Adidas subscription BFF

Ellaboreted by: Gustavo Roversi

Description

This project deal with the interface between the product microservice and the frontend applications Basically, it does 5 process:

  • Create signed JWT's, to access other endpoints
  • Create a subscription
  • List a subscription by id
  • List all subscriptions
  • Cancel a subscription

Features

  • MongoDB
  • Swagger: /adidas/api/swagger-ui.html#
  • Actuator: /adidas/api/actuator/health
  • Traceability and Observability
  • Authorization Endpoint
  • Circuit breaker
  • Docker compatible
  • Azure compatible

#Endpoints

  • POST: /adidas/api/v1/auth - Create signed JWT for access to the other endpoints
  • POST: /adidas/api/v1/subscription - Create a subscription
  • GET: /adidas/api/v1/subscription/{subscriptionID} - Get a subscription by Id
  • GET: /adidas/api/v1/subscription - List all subscriptions
  • DELETE: /adidas/api/v1/subscription - Logically delete a subscription

PS: All endpoints, excepts from 'auth', needs a JWS to authorize it access.

For more details, see the swagger documentation. (On the repo is also included a Postman collection).

#Dependencies This project needs other projects do work properly. Please download and run the other projects:

For more doubts, reade README section of these projects.

How to run

  • To start application locally, set JVM environment variable.
 spring.profiles.active=local
  • As this service is a Cloud Native application, for production environments, just let the application run on default.

Test

  • ArchUnit tests
  • Integration tests
  • Unit tests
mvn test

Deploy

docker-compose up

CI/CD

This project brings compatibility with kubernetes environment through GitHub actions. Take a look at the .git folder and the manifests' folder.

It's necessary to adjust variables to your environment.

Contact