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.5.0.tar.gz (9.6 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.5.0-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for starlette_msgspec-0.5.0.tar.gz
Algorithm Hash digest
SHA256 fe9a2d609566ec94ef42b9aaae822f7a5ed0af9c1497a377960fa9ba693f6b79
MD5 8fbed0ebbd80425af1426c7f11e756ed
BLAKE2b-256 86dfc65265f633b19c4f5c2b413df04507d9ecc0eb0baa323792a46825f5137c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for starlette_msgspec-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 39d992510bba66aef3d07a29e35a87f750bb351077a614e2728c6bf5ca8c6502
MD5 92487a5c855dac462bc9832e80a2349b
BLAKE2b-256 f9a3b873fe3be8eeefb6db9db0341cffe6cb53633b1c9cd71d19e09522df1ffa

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