Why Router prefix and tags in FastAPI? - Purpose & Use Cases

The Big Idea

Discover how a simple prefix can save you from endless URL typing and messy code!

The Scenario

Imagine building a web app with many routes, and you have to write full paths for each endpoint manually, like '/users/create', '/users/delete', '/items/list', '/items/add'. It quickly becomes messy and hard to manage.

The Problem

Manually typing full paths for every route leads to repeated code, mistakes in URLs, and difficulty updating paths later. Also, grouping routes for documentation or organization is nearly impossible without extra work.

The Solution

Router prefixes let you set a common path for a group of routes, so you only write the unique part once. Tags help group routes logically for automatic docs and better clarity.

Before vs After

✗ Before

@app.get('/users/create')
def create_user(): pass
@app.get('/users/delete')
def delete_user(): pass

✓ After

user_router = APIRouter(prefix='/users', tags=['users'])
@user_router.get('/create')
def create_user(): pass
@user_router.get('/delete')
def delete_user(): pass
app.include_router(user_router)

What It Enables

It enables clean, organized route management and automatic grouping in API docs, making your code easier to read and maintain.

Real Life Example

When building an online store API, you can group all product-related routes under '/products' prefix and tag them as 'products' so your docs show them together clearly.

Key Takeaways

Router prefixes reduce repetition by setting a common path for related routes.

Tags group routes logically for better documentation and clarity.

Together, they make your API code cleaner and easier to maintain.