Litestar dto openapi

Litestar DTO and OpenAPI

Use this skill for DTO selection, msgspec-first schemas, request/response typing, and OpenAPI shape.

Code Style Rules

• Prefer msgspec DTOs in Litestar apps unless the project is already Pydantic-led.
• Keep persistence models separate from API DTOs.
• Use camelCase wire names while Python stays snake_case.
• Exclude server-owned fields from write DTOs.
• Treat nullability and requiredness separately: T | None permits null; only a default value makes a field optional.

Quick Reference

• DTO patterns: dto.md
• Pair with litestar-data-services when mapping service results.
• Pair with msgspec for deeper Struct modeling.

<workflow>

Workflow

1. Identify input, output, and persistence shapes separately.
2. Choose msgspec DTOs or match the existing Pydantic stack.
3. Configure excludes, partial updates, rename behavior, and media type.
4. Check the generated OpenAPI schema.

</workflow> <guardrails>

Guardrails

• Do not leak internal persistence-only fields into write DTOs.
• Do not switch an existing Pydantic-heavy project to msgspec opportunistically.
• Do not rely on untyped dict payloads when request shape is known.
• Do not treat OpenAPI as documentation only; it is the contract.

</guardrails> <validation>

Validation Checkpoint

• Request and response DTOs are explicit.
• Wire names match the API convention.
• Server-owned fields are excluded from writes.
• /schema output matches the intended contract.
• Nullable fields without defaults remain in the OpenAPI required array.

</validation> <example>

Example

from litestar.dto import DTOConfig, MsgspecDTO

class UserWriteDTO(MsgspecDTO[UserWrite]):
    config = DTOConfig(exclude={"id", "created_at"})

</example>

References Index

• dto.md

Official References

• https://docs.litestar.dev/ - Litestar documentation
• https://docs.litestar.dev/latest/reference/ - Litestar API reference
• https://github.com/litestar-org/litestar/tree/v2.24.0 - Audited Litestar 2.24.0 source

Shared Styleguide Baseline

• General
• Python
• Litestar