https://github.com/mikigal/spring-rate-limiter

Simple rate limiter library for Spring
https://github.com/mikigal/spring-rate-limiter

api limit limiter mvc rate rest spring spring-boot starter

Last synced: 9 months ago
JSON representation

Simple rate limiter library for Spring

• Host: GitHub
• URL: https://github.com/mikigal/spring-rate-limiter
• Owner: mikigal
• Created: 2021-04-24T20:32:22.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2021-04-24T21:34:54.000Z (about 5 years ago)
• Last Synced: 2025-05-29T15:12:01.683Z (about 1 year ago)
• Topics: api, limit, limiter, mvc, rate, rest, spring, spring-boot, starter
• Language: Java
• Homepage:
• Size: 60.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.MD

Awesome Lists containing this project

README

          
# spring-rate-limiter

Simple rate limiter library for Spring

## Import

#### Gradle

```groovy

maven {

    url = 'https://repo.mikigal.pl/releases'

}

compile group: 'pl.mikigal', name: 'spring-rate-limiter', version: '1.0.0'

```

#### Maven

```xml

    mikigal-repo

    https://repo.mikigal.pl/releases

    pl.mikigal

    spring-rate-limiter

    1.0.0

    compile

```

## Example usage

```java

// Enable request limiter for application

@EnableRateLimiter

@SpringBootApplication

public class ExampleApplication {

    public static void main(String[] args) {

        SpringApplication.run(ExampleApplication.class, args);

    }

}

```

```java

@RestController

public class ExampleController {

    // Allow up to 100 requests per 5 minutes for this endpoint per IP address

    @RateLimiter(max = 100, time = 5, timeUnit = TimeUnit.MINUTES)

    @GetMapping("/example")

    public String root() {

        return "success";

    }

}

```