Table of Contents

1. Summary
   • Services
   • Features
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. Contact
5. References

Summary

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

Services

 * api-gateway
 * payment-service
 * student-service
 * swagger-application
 * openai-service

Features

 * Spring Cloud Gateway
 * SpringDoc Swagger
 * Event Driven Architecture with RabbitMQ
 * micrometer-tracing dependencies to track the logs
 * 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

Getting Started

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

Prerequisites

Followings should be installed and links for how to install them.

• Java 21 or higher How to install Java

  • Set JAVA_HOME to 21 -> export JAVA_HOME=$(/usr/libexec/java_home -v 21)

• Maven How to install Maven

• Docker How to install Docker

• Run docker-compose up -d command in the docker-compose.yml directory or enable spring.docker.compose property and just run ApiGatewayApplication.java to install RabbitMQ, PostgreSQL and Keycloak

• 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 use this value in Postman environment variable.
  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. Postman should be installed, follow How to import postman collection to import files that are under the postman_collection folder

• 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 application.yml
  • HCaptcha integration was implemented in 4 different ways in HCaptchaController.java ( OPTIONAL)

• Create new secret key and replace all YOUR_API_KEY_HERE in code with this new key -> https://platform.openai.com/account/api-keys

Installation

1. Clone the repo

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

2. Run Spring Boot applications

   1. mvn clean install or mvn clean package
   2. mvn spring-boot:run

3. Additional information to access endpoints, swagger and actuator

   • Swagger: http://localhost:8080/swagger-ui/ or http://localhost:8080/swagger-ui/index.html or http://localhost:8080/swagger-ui.html
   • Actuator: http://localhost:8080/actuator

4. How to run in Docker

    1 - Open Docker Quickstart Terminal
    2 - Go to the project directory from Docker Quickstart Terminal
    3 - Create Docker image by typing the following command -> docker build -t api-gateway-service-project.jar
    4 - Type the following command to make sure docker image has been created -> docker image ls
    5 - Type the following command to run docker image -> docker run -p 9090:8080 api-gateway-service-project.jar

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/amazing-feature)
3. Commit your Changes (git commit -m 'Add some amazing features')
4. Push to the Branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Contact

• Musab Bozkurt - Linkedin

• Project Link: https://github.com/musabbozkurt/api-gateway-service.git

References

• Keycloak integration with Spring Boot Project

  • https://www.keycloak.org/getting-started/getting-started-docker
  • https://www.keycloak.org/docs/latest/securing_apps/#_spring_boot_adapter
  • https://www.keycloak.org/docs/latest/server_admin/#_service_accounts
  • https://huongdanjava.com/get-access-token-using-the-grant-type-resource-owner-password-credentials-of-oauth-2-0-from-keycloak.html
  • https://developers.redhat.com/blog/2020/11/24/authentication-and-authorization-using-the-keycloak-rest-api#
  • https://www.baeldung.com/postman-keycloak-endpoints
  • https://www.programcreek.com/java-api-examples/?api=org.springframework.security.oauth2.client.registration.ClientRegistrationRepository
  • https://github.com/edwin/java-keycloak-integration
  • Spring boot 3 Keycloak integration for beginners | The complete Guide
  • OAuth 2.0 client credentials and JWT explained along with keycloak demo
  • Secure Spring Boot Microservices with Keycloak
  • Keycloak installation with docker-compose
  • spring-boot-swagger-ui-keycloak

• https://www.baeldung.com/spring-cloud-feign-oauth-token

• https://www.baeldung.com/spring-security-registration-captcha

• https://www.baeldung.com/swagger-2-documentation-for-spring-rest-api

• https://www.codementor.io/@cristianrosu948/protecting-your-spring-boot-rest-endpoints-with-google-recaptcha-and-aop-pn7a88s7w

• https://examples.javacodegeeks.com/using-google-captcha-with-spring-boot-application/

• How to POST form-url-encoded data with Spring Cloud Feign

• HCaptcha integration with Spring Boot Project

  • HCaptcha Developer Guide documentation
  • HCaptcha Test Keys
  • HCaptcha Java Example

• OpenAI integration with Spring Boot Project

  • Create new secret key and replace all YOUR_API_KEY_HERE in code with this new key
  • openai-test-requests.http

• API Gateway with Spring Cloud Gateway in Java

  • Building an API Gateway in Java with Spring Cloud Gateway
  • Spring Cloud Gateway

• Swagger(OpenAPI Specification 3) Integration with Spring Cloud Gateway

  • Swagger(OpenAPI Specification 3) Integration with Spring Cloud Gateway — Part 2