Document FastAPI application customization - #313
Open
russlan23 wants to merge 1 commit into
Open
Conversation
Signed-off-by: russlan23 <rrusslanjr@gmail.com>
russlan23
marked this pull request as ready for review
August 4, 2026 05:19
russlan23
requested review from
arhamchopra,
emilybarrettp72,
feussy,
hintse,
ptomecek,
timkpaine and
vstolin
as code owners
August 4, 2026 05:19
timkpaine
self-requested a review
August 4, 2026 14:18
timkpaine
requested changes
Aug 4, 2026
timkpaine
left a comment
Member
There was a problem hiding this comment.
Appreciate the contribution, I'm going to hold this as the v3 docs are restructured and I want to get those in this week before changing.
Author
|
Understood, thanks. I’ll hold this as-is and revisit it once the v3 documentation restructure lands. |
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
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.
Description
Documents how a
GatewayModulecan customize the underlying FastAPI application from itsresthook. The new section coversget_fastapi(), application state, standard FastAPI middleware, and the boundary between direct FastAPI customization and gateway-managed routers, settings, and lifespan behavior.It also corrects the existing description of
GatewayWebApp: it wraps FastAPI rather than subclassing it.Closes #89.
Type of Change
Checklist
mdformatandcodespell)make test) - not run; documentation-only change