A rate limiting extension for Starlette and Fastapi
A rate limiting library for Starlette and FastAPI adapted from flask-limiter.
This package is used in various production setups, handling millions of requests per month, and seems to behave as expected.
There might be some API changes when changing the code to be fully async
, but we will notify users via appropriate semver
version changes.
The documentation is on read the docs.
slowapi
is available from pypi so you can install it as usual:
$ pip install slowapi
Most feature are coming from FlaskLimiter and the underlying limits.
Supported now:
limit
decorator on endpoint functions to apply limitsrequest
argument must be explicitly passed to your endpoint, or slowapi
won't be able to hook into it. In other words, write: @limiter.limit("5/minute")
async def myendpoint(request: Request)
pass
and not:
@limiter.limit("5/minute")
async def myendpoint()
pass
websocket
endpoints are not supported yet.PRs are more than welcome! Please include tests for your changes :)
The package uses poetry to manage dependencies. To setup your dev env:
$ poetry install
To run the tests:
$ pytest
Credits go to flask-limiter of which SlowApi is a (still partial) adaptation to Starlette and FastAPI.
It's also important to mention that the actual rate limiting work is done by limits, slowapi
is just a wrapper around it.