Skip to main content
Ctrl+K
Litestar Framework - Home
Documentation
Community
Contributing
Learn how to contribute to the Litestar project
Code of Conduct
Review the etiquette for interacting with the Litestar community
Security
Overview of Litestar's security protocols
About
Litestar Organization
Details about the Litestar organization
Releases
Explore the release process, versioning, and deprecation policy for Litestar
Release notes
What's new in 2.0
2.x Changelog
1.x Changelog
Help
Discord Help Forum
Dedicated Discord help forum
GitHub Discussions
GitHub Discussions
Stack Overflow
We monitor the litestar tag on Stack Overflow
  • GitHub
  • Discord
Documentation
Community
Contributing
Learn how to contribute to the Litestar project
Code of Conduct
Review the etiquette for interacting with the Litestar community
Security
Overview of Litestar's security protocols
About
Litestar Organization
Details about the Litestar organization
Releases
Explore the release process, versioning, and deprecation policy for Litestar
Release notes
What's new in 2.0
2.x Changelog
1.x Changelog
Help
Discord Help Forum
Dedicated Discord help forum
GitHub Discussions
GitHub Discussions
Stack Overflow
We monitor the litestar tag on Stack Overflow
  • GitHub
  • Discord

Section Navigation

Documentation

  • Usage
    • Applications
    • Routing
      • Overview
      • Route handlers
      • Parameters
    • Requests
    • Caching
    • Channels
    • CLI
    • Databases
      • SQLAlchemy
        • SQLAlchemy Models & Repository
        • Plugins
      • Piccolo ORM
    • Debugging
    • Dependency Injection
    • Data Transfer Object (DTO)
      • Basic Use
      • AbstractDTO
      • Implementing Custom DTO Classes
    • Events
    • Exceptions and exception handling
    • HTMX
    • Life Cycle Hooks
    • Logging
    • Metrics
      • OpenTelemetry
      • Prometheus
    • Middleware
      • Using Middleware
      • Built-in middleware
      • Creating Middleware
    • OpenAPI
      • Configuring schema generation
      • OpenAPI UI Plugins
    • Plugins
      • Flash Messages
      • Problem Details
    • Responses
    • Security
      • Implementing Custom Authentication
      • Security Backends
      • Guards
      • Excluding and including endpoints
      • JWT Security Backends
      • Handling Secrets
    • Static files
    • Custom types
    • Stores
    • Templating
    • Testing
    • WebSockets
  • API reference
    • app
    • background_tasks
    • channels
      • plugin
      • subscriber
      • backends
        • base
        • memory
        • redis
        • psycopg
        • asyncpg
    • cli
    • config
    • connection
    • contrib
      • HTMX
      • jinja
      • jwt
      • mako
      • opentelemetry
      • piccolo_orm
      • pydantic
      • sqlalchemy
        • plugins
        • repository
        • types
        • base
        • DTO
    • controller
    • concurrency
    • data_extractors
    • datastructures
      • secret_values
    • di
    • dto
      • config
      • data_structures
      • field
      • types
      • base_dto
      • msgspec_dto
      • dataclass_dto
    • enums
    • events
    • exceptions
    • handlers
    • logging
      • config
      • picologging
      • standard
    • middleware
      • allowed_hosts
      • authentication
      • compression
      • cors
      • csrf
      • logging
      • rate_limit
      • session
        • base
        • client_side
        • server_side
    • openapi
      • openapi
      • plugins
      • spec
    • pagination
    • params
    • plugins
      • flash
      • htmx
      • problem details
      • pydantic
      • structlog
      • sqlalchemy
    • repository
      • abc
      • filters
      • exceptions
      • testing
      • handlers
    • response
      • base
      • file
      • redirect
      • streaming
      • SSE (Server Sent Events)
      • template
    • router
    • routes
    • security
      • jwt
      • session_auth
    • serialization
    • static_files
    • status_code
    • stores
      • base
      • file
      • memory
      • redis
      • registry
    • template
    • testing
    • types
    • typing
  • Benchmarks

Guides

  • Migrating to Litestar
    • From Flask
    • From Starlette / FastAPI
  • Topics
    • Sync vs. Async
    • Deployment
      • NGINX Unit
      • Manually with ASGI server
      • Docker
      • Supervisor (Linux)
  • Tutorials
    • Developing a basic TODO application
      • Application basics
      • Accessing the list
      • Making the list interactive
      • Recap and assembling the final application
    • Improving the TODO app with SQLAlchemy
      • Introduction
      • Providing the session with DI
      • Using the serialization plugin
      • Using the init plugin
      • Final touches and recap
    • Data Transfer Object Tutorial
      • Our first DTO
      • Excluding from nested models
      • Excluding from collections of nested models
      • Max nested depth
      • Renaming fields
      • Receiving data
      • Read only fields
      • Accessing the data
      • Updating instances
      • Declaring DTOs on app layers
    • SQLAlchemy Repository Tutorial
      • Introduction to Database Modeling and Repository Features
      • Interacting with repositories
      • Working with Controllers and Repositories
      • Adding Additional Features to the Repository

Contributing

  • Contribution Guide
  • Available Issues
  • API reference
  • contrib

contrib#

  • HTMX
  • jinja
  • jwt
  • mako
  • opentelemetry
  • piccolo_orm
  • pydantic
  • sqlalchemy

previous

connection

next

HTMX

© Copyright 2024, Litestar-Org.

Created using Sphinx 7.1.2.

Built with the PyData Sphinx Theme 0.14.4.