ratelimiter

KO | EN

gitlite — search

#javascript #react #typescript #golang #android #rust #nodejs #macos #java #windows #vue #security #mcp #open-source

(★ 22)

Spring Boot Rate Limiter with Redis (Spring Boot, Java 21, JUnit, Integration Test, Github Actions, Test Container, Docker, Redis)

ratelimiter 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# RATE LIMITER WITH REDIS

### 📖 Information

<ul style="list-style-type:disc">
 <li>This application is a Spring Boot application demonstrating rate limiting with Redis for user management operations.</li>
 <li>
 Explanation:
 <ul>
 <li>UserController: The API endpoint for managing user information. It includes methods to handle creating, retrieving, updating, and deleting user data. This controller interacts with the UserService to perform these operations.</li>
 <li>UserService: Contains the business logic for user management. It performs CRUD operations on the User entity and interacts with the RateLimiterService to apply rate limiting rules.</li>
 <li>RateLimiterService: Utilizes Redis to track and enforce rate limiting rules. It ensures that the number of requests made by a user does not exceed the specified limit within a given time window.</li>
 <li>UserRepository: Extends Spring Data JPA's JpaRepository, providing methods for performing database operations on user entities. This layer abstracts the data access operations, making it easier to manage user data.</li>
 <li>Redis Configuration: Redis is configured to support rate limiting functionality. The configuration includes setting up a RedisTemplate for efficient data access and operations. This template handles the interactions with Redis, such as incrementing request counts and setting expiration times for keys, ensuring accurate rate limiting.</li>
 <li>Validation: The application uses Hibernate Validator for validating user input. This ensures that the data passed to the API endpoints is in the correct format and adheres to the defined constraints.</li>
 <li>Exception Handling: Custom exception handling mechanisms are implemented to manage various error scenarios, such as user not found, email already exists, and rate limit exceeded.</li>
 </ul>
 </li>
</ul>

### Explore Rest APIs

<table style="width:100%">
 <tr>
 <th>Method</th>
 <th>Url</th>
 <th>Description</th>
 <th>Request Body</th>
 <th>Header</th>
 <th>Valid Path Variable</th>
 <th>Request Param</th>
 <th>No Path Variable</th>
 </tr>
 <tr>
 <td>POST</td>
 <td>/api/v1/users/save</td>
 <td>Create a new user</td>
 <td>CreateUserRequest</td>
 <td></td>
 <td></td>
 <td></td>
 <td></td>
 </tr>
 <tr>
 <td>GET</td>
 <td>/api/v1/users/{id}</td>
 <td>Retrieve a user by ID</td>
 <td></td>
 <td></td>
 <td>{id} - Valid UUID</td>
 <td></td>
 <td></td>
 </tr>
 <tr>
 <td>PUT</td>
 <td>/api/v1/users/{id}</td>
 <td>Update an existing user</td>
 <td>UpdateUserRequest</td>
 <td></td>
 <td>{id} - Valid UUID</td>
 <td></td>
 <td></td>
 </tr>
 <tr>
 <td>DELETE</td>
 <td>/api/v1/users/{id}</td>
 <td>Delete a user by ID</td>
 <td></td>
 <td></td>
 <td>{id} - Valid UUID</td>
 <td></td>
 <td></td>
 </tr>
 <tr>
 <td>GET</td>
 <td>/api/v1/users</td>
 <td>Retrieve a paginated list of users</td>
 <td>UserPagingRequest</td>
 <td></td>
 <td></td>
 <td></td>
 <td></td>
 </tr>
</table>

---
### Technologies

- Java 21
- Spring Boot 3.0
- Restful API
- Lombok
- Maven
- Junit5
- Mockito
- Integration Tests
- Docker
- Docker Compose
- CI/CD (Github Actions)
- Postman
- Spring Bean Validation

---
### Postman

```
Import postman collection under postman_collection folder
```

---
### Prerequisites

#### Define Variable in .env file

```
DATABASE_USERNAME={DATABASE_USERNAME}
DATABASE_PASSWORD={DATABASE_PASSWORD}
```

---
- Maven or Docker
---

### Docker Run
The application can be built and run by the `Docker` engine. The `Dockerfile` has multistage build, so you do not need to build and run separately.

Please follow directions shown below in order to build and run the application with Docker Compose file;

```sh
$ cd ratelimiter
$ docker-compose up -d
```

If you change anything in the project and run it on Docker, you can also use this command shown below

```sh
$ cd ratelimiter
$ docker-compose up --build
```

---
### Maven Run
To build and run the application with `Maven`, please follow the directions shown below;

```sh
$ cd ratelimiter
$ docker run --name redis -p 6379:6379 -d redis
$ mvn clean install
$ mvn spring-boot:run
```

---
### Docker Image Location

```
https://hub.docker.com/repository/docker/noyandocker/ratelimiter/general
```

---
### Screenshots

<details>
<summary>Click here to show the screenshots of project</summary>
 Figure 1 
 <img src ="screenshots/docker1.PNG">
 Figure 2 
 <img src ="screenshots/1.PNG">
 Figure 3 
 <img src ="screenshots/2.PNG">
 Figure 4 
 <img src ="screenshots/3.PNG">
 Figure 5 
 <img src ="screenshots/4.PNG">
 Figure 6 
 <img src ="screenshots/5.PNG">
 Figure 7 
 <img src ="screenshots/6.PNG">
 Figure 8 
 <img src ="screenshots/docker2.PNG">
</details>

### Contributors

- [Sercan Noyan Germiyanoğlu](https://github.com/Rapter1990)

ratelimiter

ratelimiter 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

ratelimiter

ratelimiter 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README