Home Search Pricing Get inErrata About

Sign in Sign up

Graph/route-decorator-misuse

AntiPattern

Route Decorator Misuse

route-decorator-misuse

A recurring routing configuration mistake where using the generic route decorator on Starlette/FastAPI APIRouter leads to confusing behavior or discouraged patterns, and the fix is to use api_route or method-specific decorators like @router.get.

Node Details

Public graph metadata

Updated4/30/2026

Connections

30 linked nodes

MATCHESSolution

this doesn't work for tanstack router. For example, I have a dynamic route `/items/$itemId.tsx`. Tension: it gives me an error that `$itemId.tsx` should be in kebab-case. Outcome: override Biome config to disable this rule in `routes`.

MATCHESSolution

Use `AnyRoute` as the common type for arbitrary route objects and type the `route` property as `AnyRoute` (e.g., `import type { AnyRoute } from '@tanstack/react-router';`). Then access the route’s `path` from the route instance.

MATCHESSolution

Configure Next.js middleware to match /api/:path* so requests can be tracked and routed consistently

MATCHESSolution

the convention for tanstack router is indeed to prefix components with `-` — I don't want the page Component file (Home.tsx) to be factored in for routing. Tension: This way this file is ignored. Outcome: It looks like the convention for tanstack router is indeed to prefix components with `-`:.

MATCHESSolution

A fix was applied to TanStack Router to stop using the route as the top-level key, allowing the existing component tree to be reused so the Tabs animation works correctly.

MATCHESSolution

if using a bundler plugin, build your project or start a dev server — Here is a guide on setting up the file based router for different environments. Tension: Tanstack Router generates a file `routeTree.gen.ts`. Outcome: which declares the interface `FileRoutesByPath`.

MATCHESSolution

Handle authentication/401 redirects via TanStack Router route guards (e.g., use beforeLoad in an authenticated parent route and throw redirect({ to: '/login' })) so the router performs the redirect as part of its normal route resolution and triggers the correct re-render.

MATCHESSolution

use hash-based routing — react + tanstack router + github pages. Tension: The default "browser" routing will exhibit the behaviour you describe.

MATCHESSolution

Replace `userouter` with Next.js' `useRouter` hook (e.g., `import { useRouter } from 'next/router'; const router = useRouter();`) and ensure routing code is SSR-compatible.

MATCHESSolution

Set redirect_slashes=False and add both "" and "/" route decorators so both /api/users and /api/users/ work reliably

MATCHESSolution

Change the imports to use proper type-only syntax, e.g. `import type { Route } from "./+types/post"` (and similarly for other `+types/*` imports) so the types are erased at build time.

MATCHESSolution

Each route with a decorator are registred in a dictionary with their trace/error rate — I then used a trace_sampler/before_send function as indicated here. Tension: I finally managed to do it using a registry mechanism. Outcome: Each route with a decorator are registred in a dictionary with their trace/error rate. I then used a trace_sampler/before_send function as indicated here.

MATCHESSolution

Yes, it's Ok to use such decorators. — @review_router.get("/review") @admin_required async def get_review():. Tension: This use-case is covered by tests in FastAPI repo. Outcome: This use-case is covered by tests in FastAPI repo: https://github.com/fastapi/fastapi/blob/6513d4daa16a536d17743de6a292f49bd06388a4/tests/test_dependency_wrapped.py#L183-L200.

MATCHESSolution

Removing `async` before the function definition solved it. — class LoggingAPIRoute(APIRoute):. Outcome: def get_route_handler(self) -> Callable:.

MATCHESSolution

Fix the imports to consistently reference the same module path (e.g., remove the `src.` prefix or otherwise ensure identical import paths for the `Document` model used during initialization and in route handlers).

MATCHESSolution

Consider using custom APIRoute instead. — It's quite similar to middleware in functionality, but it's called after the routing. Tension: there is no easy way to get this information. Outcome: app.router.route_class = LoggingRouter.

MATCHESSolution

Set FastAPI's `root_path` to the gateway prefix (e.g., `root_path="/myapp"`) so generated OpenAPI and documentation routes include the correct path.

MATCHESSolution

Upgrade/downgrade FastAPI (and underlying Starlette) to compatible versions, e.g., reinstall with a specific FastAPI version such as fastapi==0.115.6 after uninstalling fastapi/starlette/pydantic.

MATCHESSolution

or use Depends() with Pydantic model — from fastapi import APIRouter. Outcome: async def add_job(job: Job = Depends()):.

MATCHESSolution

You should instead use the `api_route` decorator — When using `APIRouter`. Tension: The default HTTP method allowed for that decorator is `GET`, but you could customize it as desired. Outcome: Alternatively, you could simply use `@router.get`, `@router.post`, etc., decorators as usual.

MATCHESSolution

You can use multiple decorators for the same function — FastAPI. Outcome: return [{"get": "sql_alchemy_output_from_{master_i}_here"}].

MATCHESSolution

You should rather use a helper function that returns an inner function. Outcome: app.add_api_route(f"/{m.__name__.lower()}", create_endpoint(m.__name__), methods=["GET"]).

MATCHESSolution

Update the checkout router to mount the POST handler at the base path by changing router.post('/checkout', ...) to router.post('/', ...) (or otherwise align the router mount path and handler path so the final route is /api/checkout).

MATCHESSolution

Route handlers are preferably used to fetch data. — Route Handlers are a low-level abstraction, they allow to write REST API Code. Tension: While Server Actions are a high-level abstraction, and they are preferably used to mutate data on the server.

MATCHESSolution

Assign a unique `reducerPath` to each `createApi` instance and register each API’s middleware in `configureStore` using the correct pattern (e.g., `middleware: (gDM) => gDM().concat(facebookSlice.middleware, bookingSlice.middleware, ...)`).

MATCHESSolution

You should be using relative paths. — render a set of "common" routes both under the root `"/"` path and also under the `"/admin"` path. Tension: This will allow you to move a route around anywhere and it will always match relative to its parent route.

MATCHESSolution

as you're already using that route when mounting the router here.

MATCHESSolution

Use the correct route mounting and handler path so GET /api/weather is matched before the unknown-endpoint middleware

MATCHESSolution

case "CallbackRouteError": return { error: "Invalid credentials!" } — in my `login.ts` server action in the switch case clause. Tension: to return the correct errors. Outcome: bypass this error.

MATCHESSolution

Use a dedicated pure helper instead of an inline replace. Outcome: accept BOTH path and uri as the locator everywhere you route by file.

[inerrata]Tags Knowledge Graph Docs About Team Pricing Contact Report a Bug Privacy Terms Cookie Settings Do Not Sell or Share My Info

© 2026 Inerrata