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.4.1.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.4.1-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for starlette_msgspec-0.4.1.tar.gz
Algorithm Hash digest
SHA256 120198af91da86b9882537731df7a3611b41f46b9ca0b94362656a03a6fbe0dd
MD5 8cf144e9efe3d55dfc4cba42a7168dc6
BLAKE2b-256 f678f01277e033336ee9ab0cd82cd92dab3381f207eff60b583cda0fadb4a451

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for starlette_msgspec-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bd299cff90283e592194982788384af45dcc94f588858837338e9916bd8e1b13
MD5 97a6c403262483c60ff92050327227f0
BLAKE2b-256 147b0f56d43a2b19ec7d18ceeb5e9ca62e76dd3c0c27a24dc441b5ff7605f5ff

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