Skip to content

Document FastAPI application customization - #313

Open
russlan23 wants to merge 1 commit into
Point72:mainfrom
russlan23:agent/document-fastapi-customization
Open

Document FastAPI application customization#313
russlan23 wants to merge 1 commit into
Point72:mainfrom
russlan23:agent/document-fastapi-customization

Conversation

@russlan23

Copy link
Copy Markdown

Description

Documents how a GatewayModule can customize the underlying FastAPI application from its rest hook. The new section covers get_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

  • Bug fix
  • New feature
  • Documentation update
  • Refactor / code cleanup
  • CI / build configuration
  • Other (describe below)

Checklist

  • Documentation linting passes (mdformat and codespell)
  • Tests pass (make test) - not run; documentation-only change
  • New tests added for new functionality - not applicable
  • Documentation updated
  • Changelog / version bump - not applicable

Signed-off-by: russlan23 <rrusslanjr@gmail.com>
@russlan23
russlan23 marked this pull request as ready for review August 4, 2026 05:19
timkpaine

This comment was marked as outdated.

@timkpaine
timkpaine self-requested a review August 4, 2026 14:18
@timkpaine
timkpaine dismissed their stale review August 4, 2026 14:19

wrong way

@timkpaine timkpaine left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@russlan23

Copy link
Copy Markdown
Author

Understood, thanks. I’ll hold this as-is and revisit it once the v3 documentation restructure lands.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add documentation on customizing fastapi instance

2 participants