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.3.0.tar.gz (9.4 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.3.0-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for starlette_msgspec-0.3.0.tar.gz
Algorithm Hash digest
SHA256 0a5d275120d083f4114fd0022d10319c9394c6f3b02c4411d9ce85573928a4dd
MD5 aae5adc3f2ac19e4ddf549b7d96c9660
BLAKE2b-256 28240385d6a6c5d744119c1c5ee0aebe8c83f7ffc3dd53f6c69359d83df6fbd5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for starlette_msgspec-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 465a036ff0d0232ebaf04345cc4637389b694b88b793781634b1ac0744e32099
MD5 122d32b1770ed35ccbb95698ae7d872c
BLAKE2b-256 60883a005f38edbdc0cfc839e47fc6619766cbe70de6792b7ff1754bf04353ab

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