From 319fea3781669a3cce17c92d8d3f93c218af77f9 Mon Sep 17 00:00:00 2001 From: Synrom Date: Sun, 15 Sep 2024 13:46:25 +0200 Subject: [PATCH] :memo: Add more documentation on `ignore_trailing_slash` --- fastapi/applications.py | 5 +++++ fastapi/routing.py | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/fastapi/applications.py b/fastapi/applications.py index f44f52ed3..58d5b268a 100644 --- a/fastapi/applications.py +++ b/fastapi/applications.py @@ -821,6 +821,11 @@ class FastAPI(Starlette): By default (`ignore_trailing_slash` is False), the two requests are treated differently. One of them will result in a 307-redirect. + + It's important to understand that when `ignore_trailing_slash=True`, registering both `/auth` + and `/auth/` as different routes will be treated as if `/auth` was registered twice. + This means that only the first route registered will be used. + Therefore, ensure your route setup does not conflict unintentionally. """ ), ] = False, diff --git a/fastapi/routing.py b/fastapi/routing.py index 7d5e5c21a..cec5075e8 100644 --- a/fastapi/routing.py +++ b/fastapi/routing.py @@ -842,6 +842,11 @@ class APIRouter(routing.Router): By default (`ignore_trailing_slash` is False), the two requests are treated differently. One of them will result in a 307-redirect. + + It's important to understand that when `ignore_trailing_slash=True`, registering both `/auth` + and `/auth/` as different routes will be treated as if `/auth` was registered twice. + This means that only the first route registered will be used. + Therefore, ensure your route setup does not conflict unintentionally. """ ), ] = False,