A rate limiting library for Starlette and FastAPI adapted from flask-limiter.
Note: this is alpha quality code still, the API may change, and things may fall apart while you try it.
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.
limitdecorator on endpoint functions to apply limits
requestargument must be explicitly passed to your endpoint, or
slowapiwon't be able to hook into it. In other words, write:
@limiter.limit("5/minute") async def myendpoint(request: Request) pass
@limiter.limit("5/minute") async def myendpoint() pass
websocketendpoints 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:
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.