Enable Burr UI to be added to existing FastAPI app#671
Open
Smitaambiger wants to merge 2 commits intoapache:mainfrom
Open
Enable Burr UI to be added to existing FastAPI app#671Smitaambiger wants to merge 2 commits intoapache:mainfrom
Smitaambiger wants to merge 2 commits intoapache:mainfrom
Conversation
… UI into existing FastAPI apps
skrawcz
reviewed
Mar 12, 2026
| Mount the Burr UI inside another FastAPI app. | ||
| """ | ||
| ui_app = create_burr_ui_app() | ||
| parent_app.mount(path, ui_app, name="burr-ui") |
Contributor
There was a problem hiding this comment.
let's expose name as a parameter
skrawcz
reviewed
Mar 12, 2026
|
|
||
| def mount_burr_ui(parent_app: FastAPI, path: str = "/burr") -> None: | ||
| """ | ||
| Mount the Burr UI inside another FastAPI app. |
Contributor
There was a problem hiding this comment.
and example code on how to mount it from some other code.
Also can you add and example to /examples and docs to docs/ for this new feature you're adding so that it's documented on how to use it? The example will show folks and prove out that this works.
Contributor
Author
|
@skrawcz,Thanks for the feedback! I've updated the PR to: • expose the Let me know if any further adjustments are needed. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a reusable FastAPI factory and helper function to allow the Burr UI
to be mounted inside an existing FastAPI application.
Changes:
create_burr_ui_app()factory to construct the Burr UI FastAPI app.mount_burr_ui(parent_app, path="/burr")helper to mount the UI as a sub-application.app = create_burr_ui_app().This enables users to run Burr tracking UI alongside their own FastAPI services
in the same application.
Closes #503