Skip to content

Latest commit

 

History

History
122 lines (86 loc) · 3.42 KB

README.md

File metadata and controls

122 lines (86 loc) · 3.42 KB
Raw

Spring Boot Library - Rate Limiter

This Rate Limiter uses the Token Bucket Algorithm to determine if the request can be processed or not.

How to use.

Clone, Compile And Add the dependency.

Clone this project and compile it with mvn clean install.

Add the dependency:

<dependency>
  <groupId>com.changolaxtra.cloud</groupId>
  <artifactId>rate-limiter</artifactId>
  <version>1.0.2</version>
</dependency>

Note: Public repository with artifact is pending.

Add the @EnableApiRateLimiter.

By adding this annotation to main Spring Boot class the required beans will be activated.

import com.changolaxtra.cloud.ratelimiter.annotations.EnableApiRateLimiter;

@EnableApiRateLimiter
@SpringBootApplication
public class ApiApplication {

	public static void main(String[] args) {
		SpringApplication.run(ApiApplication.class, args);
	}

}

Configure default policy.

The library default policy can be overridden by adding the below configuration to the application.yaml or application.properties file.

The default policy reads the X-API-Key header in the HTTP Request, the API Key is blank and only one request can be processed by minute.

Note: If isUnlimited is set as true, it means that all the request for that API Key will be processed and the other parameters will be ignored.

rate-limiter:
  apiKey-header-name: "X-API-Key"
  default-policy:
    apiKey: ""
    isUnlimited: false
    allowedRequests: 1
    windowSizeInMilliSeconds: 60000

Create more policies.

This library allows to create more API Key Policies, by creating the model and calling the saveOrUpdate method in the repository.

  • Example of creating and adding one policy:

Note: If isUnlimited is set as true, it means that all the request for that API Key will be processed and the other parameters will be ignored.

import com.changolaxtra.cloud.ratelimiter.core.PlanLimitBucket;
import com.changolaxtra.cloud.ratelimiter.core.policy.RateLimitPolicy;
import com.changolaxtra.cloud.ratelimiter.storage.EmbeddedPlanLimitStorage;

@Component
public class ClientApiInitializer {

    private final EmbeddedPlanLimitStorage embeddedPlanLimitStorage;
    
    public ClientApiInitializer(final EmbeddedPlanLimitStorage embeddedPlanLimitStorage) {
        this.embeddedPlanLimitStorage = embeddedPlanLimitStorage;
    }

    @PostConstruct
    public void init() {
        final RateLimitPolicy rateLimitPolicy = RateLimitPolicy
                .builder()
                .apiKey("a1919bfc-9b12-4927-9455-a0231ba953d5")
                .allowedRequests(25L)
                .isUnlimited(false)
                .windowSizeInMilliSeconds(120_000)
                .build();
        
        embeddedPlanLimitStorage.saveOrUpdate(new PlanLimitBucket(rateLimitPolicy));
    }
}

Add the @ApiRateLimited.

Use the annotation @ApiRateLimited in the methods that should be limited using the policies.

If the limit is reached an HTTP 429 (Too Many Requests) will be returned.

import com.changolaxtra.cloud.ratelimiter.annotations.ApiRateLimited;

@RestController
@RequestMapping("/card")
public class CardController {

  @ApiRateLimited
  @ResponseBody
  @PostMapping(produces = MediaType.APPLICATION_JSON_VALUE,
      consumes = MediaType.APPLICATION_JSON_VALUE)
  public CreateCardResponse create(@RequestBody final CreateCardRequest request) {
    return cardService.create(request);
  }
  
}