Skip to main content

FastAPI-like router for Starlette with msgspec integration

Project description

starlette-msgspec

A FastAPI-like router for Starlette with msgspec integration for automatic request validation and OpenAPI documentation.

Installation

# Install with pip
pip install starlette-msgspec

# Or with uv
uv pip install starlette-msgspec

# For development on this library
uv sync --dev

Usage

from starlette.applications import Starlette
from starlette_msgspec import MsgspecRouter, add_openapi_routes
import msgspec
from typing import List


# Define your data model with msgspec
class Item(msgspec.Struct):
    name: str
    description: str = ""
    price: float
    tax: float = 0.0


app = Starlette()
router = MsgspecRouter()


@router.post("/items", tags=["items"])
async def create_item(body: Item):
    return body


@router.get("/items", tags=["items"])
async def get_items() -> List[Item]:
    # ... implementation
    return [Item(name="Example", price=10.5)]


# Include the router and add OpenAPI documentation routes
router.register_routes(app)
add_openapi_routes(app)

💡 For a more comprehensive example showing multiple routers, different data models, and advanced features, check out examples/basic_app.py.

Features

  • FastAPI-like router with method, path, and tags
  • Automatic request validation based on msgspec types
  • OpenAPI documentation generation using msgspec's built-in schema capabilities
  • Type annotations for request body and response

Running the example

# Install dependencies
uv sync --dev

# Run the example
uv run examples/basic_app.py

Then visit http://localhost:8000/docs to see the Swagger UI documentation.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

starlette_msgspec-0.6.0.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

starlette_msgspec-0.6.0-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file starlette_msgspec-0.6.0.tar.gz.

File metadata

  • Download URL: starlette_msgspec-0.6.0.tar.gz
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.5

File hashes

Hashes for starlette_msgspec-0.6.0.tar.gz
Algorithm Hash digest
SHA256 a554c081f73683699fca43f7e9bc8d36bf749bd7fa57f5e8e2b9df6ebe82faa7
MD5 524895cd537131ec7afb596af51c4628
BLAKE2b-256 d6e7861539b17c6062aee680ea1806a9968665bffc4bbdef1144abae5cd1d0a7

See more details on using hashes here.

File details

Details for the file starlette_msgspec-0.6.0-py3-none-any.whl.

File metadata

File hashes

Hashes for starlette_msgspec-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 51be290e3bc1f3abd95b79c46fdf6f61703d92ee1d9785e10a90b27df85f42c8
MD5 a7856c936f4a1bb05fb751a1b9114617
BLAKE2b-256 53e3a51f0ef84e6507f16e67bbb8528beef4ae016dafca7749b42429fcea646c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page