add slowapi

book/cooltools/Chapter.ipynb

@@ -2325,6 +2325,60 @@
     "\n",
     "skill_extractor.describe(annotations)"
    ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Rate Limiting FastAPI with `slowapi`"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Preventing abuse of your API is crucial.\n",
+    "\n",
+    "To implement rate limiting for FastAPI, you can use `slowapi`.\n",
+    "\n",
+    "`slowapi` offers utility functions to limit your FastAPI or Starlette app based on e.g. the IP address.\n",
+    "\n",
+    "In the example below, we limit our API to 5 requests per minute.\n",
+    "\n",
+    "A note from the author: This is alpha quality code still, the API may change, and things may fall apart while you try it."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "!pip install slowapi"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from fastapi import FastAPI\n",
+    "from slowapi import Limiter, _rate_limit_exceeded_handler\n",
+    "from slowapi.util import get_remote_address\n",
+    "from slowapi.errors import RateLimitExceeded\n",
+    "\n",
+    "# Limiting based on user's IP address\n",
+    "limiter = Limiter(key_func=get_remote_address)\n",
+    "app = FastAPI()\n",
+    "app.state.limiter = limiter\n",
+    "app.add_exception_handler(RateLimitExceeded, _rate_limit_exceeded_handler)\n",
+    "\n",
+    "@app.get(\"/home\")\n",
+    "@limiter.limit(\"5/minute\")\n",
+    "async def hello(request: Request):\n",
+    "    return {\"response\":\"Hello\"}"
+   ]
   }
  ],
  "metadata": {