Skip to content

jnuwan/api-gateway-service

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Based on the details retrieved, here's a README file for the api-gateway-service repository:

# API Gateway Service

API gateway service demo application using Spring Boot.

## Table of Contents

- [Overview](#overview)
- [Features](#features)
- [Technologies](#technologies)
- [Getting Started](#getting-started)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)

## Overview

The `api-gateway-service` is a demo application that implements an API Gateway using Spring Boot. It provides a single entry point for client requests, routing them to the appropriate microservices.

## Features

- Routing client requests to various microservices.
- Load balancing.
- Circuit breaking.
- Rate limiting.
- Security features like authentication and authorization.

## Technologies

- **Programming Language**: Java
- **Framework**: Spring Boot
- **API Gateway**: Spring Cloud Gateway
- **Build Tool**: Maven

## Getting Started

### Prerequisites

- Java 11 or higher
- Maven

### Installation

1. Clone the repository:
   ```bash
   git clone https://github.com/jnuwan/api-gateway-service.git
   cd api-gateway-service
  1. Build the project using Maven:

    mvn clean install
  2. Configure your gateway settings in application.properties.

Running the Application

To run the application locally, use the following command:

mvn spring-boot:run

This will start the API Gateway, and you can access it at http://localhost:8080.

Usage

Once the API Gateway is running, it will route incoming requests to the appropriate microservices based on the configuration in application.properties. Below is an example configuration for routing to a microservice:

spring.cloud.gateway.routes[0].id=product-service
spring.cloud.gateway.routes[0].uri=http://localhost:8081
spring.cloud.gateway.routes[0].predicates[0]=Path=/products/**

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

Steps to Contribute

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-branch).
  3. Make your changes.
  4. Commit your changes (git commit -m 'Add some feature').
  5. Push to the branch (git push origin feature-branch).
  6. Open a pull request.

License

This project is not currently licensed under any specific license.

Contact


Feel free to customize the sections such as `Technologies` and `Contact` with specific details relevant to your project and personal information.

About

API gateway service demo application using spring boot

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages