Table of Contents

1. Summary
   • Services
   • Features
2. Getting Started
   • Prerequisites
   • Installation
3. References

---

Summary

• api-gateway-service project established by combination of the following services and features

Services

 * api-gateway
 * notification-service
 * openai-service
 * payment-service
 * service-registry
 * spring-config-server
 * student-service
 * swagger-application

Features

 * Spring Cloud Gateway
 * SpringDoc Swagger
 * Event Driven Architecture with RabbitMQ
 * Event Driven Architecture with Apache Kafka (notification-service)
 * micrometer-tracing dependencies to track the logs
 * OpenTelemetry (OTLP) export for metrics, traces, and logs to Grafana LGTM stack
 * Postman collection to test by using Postman
 * Keycloak integration is completed under the payment-service
 * Feign Client secure call with Keycloak integration is completed under the student-service
 * MDC was added to improve logging between microservices
 * Google reCAPTCHA was added to secure endpoint calls
 * HCaptcha repo migration is completed under the student-service
 * openai-service repo migration is completed
 * Spring Cloud Eureka Server and Client integrations are completed with service-registry repo
 * KubernetesDeploymentGuide.md is added
 * Spring Config Server integration is completed with git version control
 * notification-service with Email, SMS (DummySms), Push (Firebase FCM + SSE) and Kafka-based notification support
 * Configurable security permitted paths via application.yml (gateway-service.security.permitted-paths)
 * Multi-application Firebase push notification support in notification-service

---

Getting Started

• To get a local copy up and running please follow these steps

---

Prerequisites

• Followings should be installed and links for how to install them
  • Java 25 or higher How to install Java
    • Set JAVA_HOME to 25 -> export JAVA_HOME=$(/usr/libexec/java_home -v 25)
  • Maven How to install Maven
  • Docker How to install Docker
  • Postman can be installed (OPTIONAL), follow how to import postman collection to import files that are under the postman_collection folder
  • Create a new secret key via this url, copy the value, and add it as YOUR_API_KEY_HERE value in the .env
  • Google reCAPTCHA installation (OPTIONAL)
    • Log in to the https://www.google.com/recaptcha/admin/create
    • Fill the necessary fields.
      • This url can guide you
    • Copy SITE_KEY and SECRET_KEY and add them into related fields that are in the .env
  • HCaptcha integration was implemented in 4 different ways in HCaptchaController.java (OPTIONAL)

---

Installation

1. Clone the repo

    git clone https://github.com/musabbozkurt/api-gateway-service.git

2. Run all services

   • (OPTION 1)
     • Run docker-compose --profile start_application up -d --build command in the docker-compose.yml directory
   • (OPTION 2)
     1. Enable spring.docker.compose property and just run ApiGatewayApplication.java to install RabbitMQ, PostgreSQL and Keycloak
     2. Run mvn clean install or mvn clean package or ./mvnw clean install or ./mvnw clean package command under each service's directory
     3. Run mvn spring-boot:run command under each service's directory

3. Log in to http://localhost:9090/admin with username: admin and password: admin
   1. Create realm --> Import payment-service-realm-export.json
   2. Clients --> payment-service --> Credentials --> Regenerate copy the value and add it as PAYMENT_CLIENT_SECRET_ENV value in the .env
   3. Users --> Add user --> Username --> payment-service-user
   4. Users --> payment-service-user --> Credentials --> Set password to test and turn off Temporary toggle
   5. Users --> payment-service-user --> Role Mapping --> Assign role add admin role
   6. Restart student-service to fetch PAYMENT_CLIENT_SECRET

4. Additional information to access endpoints, swagger and actuator

   • Swagger: http://localhost:8080/swagger-ui.html
     • Open Swagger --> select Payment Service definition --> Click Authorize
       1. Enter the following credentials into the pop-up window
          1. username: payment-service-user
          2. password: test
          3. client_id: payment-service
          4. client_secret: PAYMENT_CLIENT_SECRET_ENV value in the .env
       2. 
       3. Click Authorize to get token
       4. Click Close and test the services
   • Actuator: http://localhost:8080/actuator
   • Eureka: http://localhost:8761/
   • RabbitMQ Management: http://localhost:15673/ with username: guest and password: guest
   • PostgreSQL: jdbc:postgresql://localhost:5433/postgres with username: postgres and password: postgres
   • Redis: http://localhost:6379/
   • RedisInsight: http://localhost:5540/
   • Zipkin: http://localhost:9411/
   • Grafana: http://localhost:3001/ with username: admin and password: admin
   • Kafka UI: http://localhost:9999/
   • spring-config-server
     • Health: http://localhost:8888/actuator/health
     • Config for swagger-application: http://localhost:8888/swagger-application/development/main
   • Mailpit UI: http://localhost:8025/
     • username: admin
     • password: admin
     • Mailpit is a local SMTP server for testing email sending functionality without actually sending emails to real addresses. It captures and displays emails sent by the application, allowing developers to verify email content and functionality during development.

5. Kubernetes Deployment Guide (OPTIONAL)

---

References

• References
• KEYCLOAK_FLOW.md

---