Why Including routers in main app in FastAPI? - Purpose & Use Cases

The Big Idea

Discover how splitting your routes can save hours of frustration and make your app shine!

The Scenario

Imagine building a web app where you write all your routes in one big file. As your app grows, this file becomes huge and hard to manage.

You want to add new features, but finding where to put new routes or how to organize them is confusing.

The Problem

Writing all routes manually in one place makes the code messy and hard to read.

It's easy to make mistakes like duplicate paths or forget to update parts of the app.

Testing and updating features becomes slow and frustrating.

The Solution

Including routers in the main app lets you split routes into smaller, focused files.

Each router handles a specific part of your app, making the code clean and easy to maintain.

FastAPI automatically combines these routers, so your app works smoothly without extra hassle.

Before vs After

✗ Before

from fastapi import FastAPI

app = FastAPI()

@app.get('/users')
def get_users():
    pass

@app.get('/items')
def get_items():
    pass

✓ After

from fastapi import FastAPI
from users import router as users_router
from items import router as items_router

app = FastAPI()
app.include_router(users_router)
app.include_router(items_router)

What It Enables

You can build large, organized apps by dividing routes into modules that work together seamlessly.

Real Life Example

A shopping website where user-related routes are in one file, product routes in another, and order routes in a third, all combined in the main app for easy updates and teamwork.

Key Takeaways

Manual route management gets messy as apps grow.

Including routers splits routes into manageable parts.

This keeps your FastAPI app clean, scalable, and easier to maintain.

Practice

1. What is the main purpose of using include_router in a FastAPI application?

easy

A. To handle user authentication automatically.

B. To automatically generate HTML templates for the app.

C. To connect the app to a database.

D. To split the app into smaller, manageable parts for better organization.

Solution

1. Step 1: Understand the role of routers in FastAPI

   Routers help organize routes by grouping related endpoints together.

2. Step 2: Recognize what include_router does

   It adds these grouped routes into the main app, keeping code clean and modular.

3. Final Answer:

   To split the app into smaller, manageable parts for better organization. -> Option D

4. Quick Check:

   Router inclusion = app organization [OK]

Hint: Routers help organize routes; include_router adds them to main app [OK]

Common Mistakes:

• Thinking include_router generates HTML templates
• Confusing routers with database connections
• Assuming include_router handles authentication

2. Which of the following is the correct way to include a router named user_router with prefix /users in a FastAPI app named app?

easy

A. app.add_router(user_router, prefix='/users')

B. app.include_router(user_router, prefix='/users')

C. app.include(user_router, prefix='/users')

D. app.router_include(user_router, prefix='/users')

Solution

1. Step 1: Recall the correct method name for adding routers

   The method is include_router, not add_router or others.

2. Step 2: Check the syntax for prefix argument

   The prefix is passed as a keyword argument prefix='/users'.

3. Final Answer:

   app.include_router(user_router, prefix='/users') -> Option B

4. Quick Check:

   Method name is include_router with prefix argument [OK]

Hint: Use include_router with prefix keyword to add routers [OK]

Common Mistakes:

• Using wrong method names like add_router
• Passing prefix as positional argument
• Misspelling include_router

3. Given this code snippet, what will be the URL path to access the get_items endpoint?

from fastapi import FastAPI, APIRouter

app = FastAPI()
router = APIRouter()

@router.get('/items')
async def get_items():
    return {'items': [1, 2, 3]}

app.include_router(router, prefix='/api')

medium

A. /api/items

B. /items

C. /router/items

D. /api/router/items

Solution

1. Step 1: Identify the route path in the router

   The endpoint is defined at /items inside the router.

2. Step 2: Understand the prefix added when including the router

   The router is included with prefix /api, so the full path is /api/items.

3. Final Answer:

   /api/items -> Option A

4. Quick Check:

   Router prefix + endpoint path = full URL [OK]

Hint: Full path = prefix + router path [OK]

Common Mistakes:

• Ignoring the prefix when accessing the endpoint
• Assuming router name appears in URL
• Confusing endpoint path with prefix

4. What is wrong with this FastAPI code snippet?

from fastapi import FastAPI, APIRouter

app = FastAPI()
router = APIRouter()

@router.get('/hello')
async def say_hello():
    return {'message': 'Hello'}

app.include_router(router, prefix='/greet')
app.include_router(router, prefix='/greet')

medium

A. Including the same router twice with the same prefix causes duplicate routes.

B. The router must be included before defining endpoints.

C. The prefix argument must be omitted when including routers.

D. The router variable should be named app_router instead of router.

Solution

1. Step 1: Check how many times the router is included

   The router is included twice with the same prefix /greet.

2. Step 2: Understand the effect of including the same router twice

   This causes duplicate routes, which can lead to errors or unexpected behavior.

3. Final Answer:

   Including the same router twice with the same prefix causes duplicate routes. -> Option A

4. Quick Check:

   Duplicate router inclusion = duplicate routes [OK]

Hint: Avoid including the same router twice with same prefix [OK]

Common Mistakes:

• Thinking router must be included before endpoints
• Believing prefix is mandatory or must be omitted
• Confusing variable naming with functionality

5. You have two routers: user_router with prefix /users and item_router with prefix /items. You want to include both in your FastAPI app and add tags for automatic docs grouping. Which code snippet correctly includes both routers with tags?

hard

A. app.include_router(user_router, prefix='/users', tags='users')
app.include_router(item_router, prefix='/items', tags='items')

B. app.include_router(user_router, prefix='/users')
app.include_router(item_router, prefix='/items')
app.tags = ['users', 'items']

C. app.include_router(user_router, prefix='/users', tags=['users'])
app.include_router(item_router, prefix='/items', tags=['items'])

D. app.include_router(user_router, tags=['users'])
app.include_router(item_router, tags=['items'])

Solution

1. Step 1: Check how to add tags when including routers

   Tags are passed as a list to the tags argument in include_router.

2. Step 2: Verify prefix and tags usage for both routers

   Each router is included with its prefix and tags as lists, e.g., tags=['users'].

3. Final Answer:

   app.include_router(user_router, prefix='/users', tags=['users']) app.include_router(item_router, prefix='/items', tags=['items']) -> Option C

4. Quick Check:

   Tags must be lists in include_router calls [OK]

Hint: Pass tags as list when including routers for docs grouping [OK]

Common Mistakes:

• Passing tags as string instead of list
• Setting tags on app instead of routers
• Omitting tags argument entirely