apiman/apiman-rls

Name: apiman-rls

Owner: apiman

Description: A standalone Rate Limiting [Micro-]Service.

Created: 2016-07-28 11:30:25.0

Updated: 2018-02-20 10:46:24.0

Pushed: 2017-12-04 17:43:24.0

Homepage: null

Size: 697

Language: HTML

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

apiman-rls

A standalone Rate Limiting [Micro-]Service.

Building

The apiman-rls project is a standard maven project, so to build it from source, simply do this:

clean package

Running

Once the project is built, there are a number of ways you can run the server. Perhaps the easiest way is to simply run the fat jar that is created in the apiman-rls-vertx module:

ertx/target
 -jar apiman-rls-vertx-${version}-fat.jar

This will start up the server on port 8080 of localhost. Point your browser or REST client at the resulting endpoint:

http://localhost:8080/

You should see a response payload with some basic information, for example:

ame" : "apiman-rls-api",
ersion" : "1.0",
escription" : "A REST API to the apiman Rate Limiting [Micro-]Service.  This API provides a way for external clients to quickly and accurately query and increment named rate limits."

Getting Started

Now that the server is running, you can start making REST calls to the server. Details of the REST API can be found here:

http://docs.ratelimiterapi.apiary.io/