Skip to content

✨ Add support for custom APIRoute and APIRouter #13483

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 16 commits into
base: master
Choose a base branch
from
Open

✨ Add support for custom APIRoute and APIRouter #13483

wants to merge 16 commits into from

Conversation

Purushot14
Copy link

🚀 feat: Support Custom APIRoute and APIRouter in FastAPI

Summary

This PR introduces support for specifying custom APIRoute and APIRouter classes in FastAPI. It enhances flexibility by allowing users to override the default route and router behavior for advanced use cases.

Changes Introduced

  • Added route_class and router_class parameters to the FastAPI class.
  • Ensured that router_class is used when initializing the app’s router and webhooks.
  • Updated the initialization of self.router to use router_class, passing route_class as an argument.
  • Added test cases to validate:
    • Custom route and router class usage.
    • Route naming consistency.
    • The presence of X-Response-Time header in responses.

Why This is Needed

  • Enables developers to define and use custom route handlers and routers, making FastAPI more extensible.
  • Useful for adding cross-cutting concerns like request logging, timing, or permission handling at the router level.

Testing & Validation

  • Added automated test cases in docs_src.custom_api_router.tutorial001.
  • Verified that route names, router classes, and custom headers behave as expected.

Related Issues or Discussions

(If applicable, link related issues or discussions here)

Purushot14 and others added 4 commits March 13, 2025 00:09
@Purushot14
feat: Add support for custom APIRoute and APIRouter in FastAPI
3c1d6eb 
- Introduced `route_class` and `router_class` parameters to allow custom route and router classes.
- Updated `FastAPI` initialization to use the provided `router_class` and `route_class`.
- Modified webhook initialization to respect the custom router class.
- Added test cases to validate:
  - Custom `route_class` and `router_class` usage.
  - Route naming consistency.
  - Presence of `X-Response-Time` header in responses.

This enhances FastAPI’s flexibility, allowing users to customize route handling and routing behavior.
@pre-commit-ci
🎨 [pre-commit.ci] Auto format from pre-commit.com hooks
820b235
@Purushot14
lint updated
dcfc537
@Purushot14
Merge branch 'master' of github.com:Purushot14/fastapi
262a799
@github-actions GitHub Actions
Copy link
Contributor

📝 Docs preview for commit 262a799 at: https://9cf8cd82.fastapitiangolo.pages.dev

Modified Pages

@github-actions GitHub Actions
Copy link
Contributor

📝 Docs preview for commit ff94d84 at: https://dab335ab.fastapitiangolo.pages.dev

Modified Pages

@github-actions GitHub Actions
Copy link
Contributor

📝 Docs preview for commit 95d9257 at: https://b03b4ecf.fastapitiangolo.pages.dev

Modified Pages

@alv2017
Copy link
Contributor

alv2017 commented Mar 12, 2025 •
edited
Loading

@Purushot14: great idea, I will definitely try this out! 😃

If it is not get accepted, you can try an alternative way that uses custom_app() 😃

@svlandeg svlandeg changed the title 🚀 feat: Add support for custom APIRoute and APIRouter in FastAPI ✨ Add support for custom APIRoute and APIRouter Mar 13, 2025
svlandeg
svlandeg reviewed Mar 13, 2025
View reviewed changes
svlandeg
svlandeg reviewed Mar 13, 2025
View reviewed changes
@svlandeg svlandeg added the feature New feature or request label Mar 13, 2025
Purushot14 and others added 3 commits March 13, 2025 18:53
@github-actions GitHub Actions
Copy link
Contributor

📝 Docs preview for commit 4e8479a at: https://dd36898e.fastapitiangolo.pages.dev

Modified Pages

@Purushot14 @svlandeg
Update test_tutorial004.py
1b8d728 
Co-authored-by: Sofie Van Landeghem <svlandeg@users.noreply.github.com>
@github-actions GitHub Actions
Copy link
Contributor

📝 Docs preview for commit 1b8d728 at: https://e1a3abf5.fastapitiangolo.pages.dev

Modified Pages

@github-actions GitHub Actions
Copy link
Contributor

📝 Docs preview for commit 2bc93e3 at: https://0b1d643b.fastapitiangolo.pages.dev

Modified Pages

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 5, 2025

📝 Docs preview for commit a7106ee at: https://8fd77e4d.fastapitiangolo.pages.dev

Modified Pages

@alv2017 alv2017 mentioned this pull request May 4, 2025
Open
@github-actions GitHub Actions
Copy link
Contributor

📝 Docs preview for commit 71db950 at: https://e629f0b5.fastapitiangolo.pages.dev

Modified Pages

@github-actions GitHub Actions
Copy link
Contributor

📝 Docs preview for commit 063c585 at: https://4214ebb3.fastapitiangolo.pages.dev

Modified Pages

@Purushot14
Copy link
Author

@svlandeg, do you have any updates on this? Can we merge this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@svlandeg svlandeg svlandeg left review comments

Assignees
No one assigned
Labels
feature New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Purushot14 @alv2017 @svlandeg
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy