Why routing organizes endpoints in FastAPI

Introduction

Routing helps organize different web addresses so your app knows what to do for each one. It keeps your code neat and easy to manage.

When you want to handle different pages or actions in a web app, like showing a homepage or user profile.

When you need to separate API endpoints for different features, like login and data fetching.

When your app grows and you want to keep code organized by grouping related paths.

When you want to respond differently based on the URL the user visits.

When you want to add new features without mixing code for old ones.

Syntax

FastAPI

from fastapi import FastAPI

app = FastAPI()

@app.get("/path")
async def function_name():
    return {"message": "response"}

Use decorators like @app.get() to connect a URL path to a function.

Each function handles one route and returns a response for that URL.

Examples

This sets up the root URL / to return a greeting message.

FastAPI

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def read_root():
    return {"message": "Hello World"}

This route uses a path parameter to get a user ID from the URL and return it.

FastAPI

from fastapi import FastAPI

app = FastAPI()

@app.get("/users/{user_id}")
async def read_user(user_id: int):
    return {"user_id": user_id}

This route handles POST requests to create a new item with data sent by the client.

FastAPI

from fastapi import FastAPI
from fastapi import Request

app = FastAPI()

@app.post("/items/")
async def create_item(item: dict):
    return {"item": item}

Sample Program

This example shows three routes: the homepage, an about page, and a user page that takes a user ID from the URL.

FastAPI

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def home():
    return {"message": "Welcome to the homepage!"}

@app.get("/about")
async def about():
    return {"message": "This is the about page."}

@app.get("/users/{user_id}")
async def get_user(user_id: int):
    return {"user_id": user_id, "info": "User details here."}

Important Notes

Routing keeps your app organized by clearly linking URLs to code.

Use path parameters to handle dynamic parts of URLs.

FastAPI automatically creates docs for your routes, making testing easier.

Summary

Routing connects URLs to specific functions in your app.

It helps keep code clean and easy to understand.

FastAPI uses decorators to define routes simply and clearly.