Models Reference¶
Reference for request and response models used throughout Apiary.
Response Models¶
Request Models¶
Request models for API endpoints.
Bases: BaseModel
Query parameters for health check endpoints.
Usage Examples¶
Using Response Models¶
from models.responses import BaseResponse
class MyResponse(BaseResponse):
"""Custom response model."""
data: dict
count: int
# All responses automatically include timestamp
response = MyResponse(data={"key": "value"}, count=1)
Using Request Models¶
from pydantic import BaseModel
class QueryParams(BaseModel):
"""Query parameters for endpoint."""
name: str
limit: int = 10
@router.get("/items")
async def get_items(params: QueryParams = Depends()):
return {"items": []}