From d3ea6f751463c9dc0dd501c047dfc616c3adb2b5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebasti=C3=A1n=20Ram=C3=ADrez?= Date: Fri, 28 Jun 2019 19:54:49 +0200 Subject: [PATCH] :memo: Add note to docs about including same router multiple times (#348) --- docs/tutorial/bigger-applications.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/tutorial/bigger-applications.md b/docs/tutorial/bigger-applications.md index f9e2f6aa7..72cc2e261 100644 --- a/docs/tutorial/bigger-applications.md +++ b/docs/tutorial/bigger-applications.md @@ -174,7 +174,6 @@ from app.routers import items, users To learn more about Python Packages and Modules, read the official Python documentation about Modules. - ### Avoid name collisions We are importing the submodule `items` directly, instead of importing just its variable `router`. @@ -216,7 +215,6 @@ It will include all the routes from that router as part of it. So, behind the scenes, it will actually work as if everything was the same single app. - !!! check You don't have to worry about performance when including routers. @@ -295,7 +293,6 @@ The end result is that the item paths are now: As we cannot just isolate them and "mount" them independently of the rest, the path operations are "cloned" (re-created), not included directly. - ## Check the automatic API docs Now, run `uvicorn`, using the module `app.main` and the variable `app`: @@ -309,3 +306,11 @@ And open the docs at http:/ You will see the automatic API docs, including the paths from all the submodules, using the correct paths (and prefixes) and the correct tags: + +## Include the same router multiple times with different `prefix` + +You can also use `.include_router()` multiple times with the *same* router using different prefixes. + +This could be useful, for example, to expose the same API under different prefixes, e.g. `/api/v1` and `/api/latest`. + +This is an advanced usage that you might not really need, but it's there in case you do.