pypaginate.adapters.fastapi.search

Declarative search dependency for FastAPI.

Parses ?q=alice&search_fields=name,email into SearchSpec. Pipeline auto-converts via the to_spec method.

Example:

@app.get("/users")
async def get_users(params: OffsetDep, search: SearchDep):
    return pipeline.execute(data, params, search=search).model_dump()

Classes

SearchDep

Parse search query parameters into SearchSpec.

Module Contents

class pypaginate.adapters.fastapi.search.SearchDep(/, **data: Any)

Bases: pydantic.BaseModel

Parse search query parameters into SearchSpec.

Query params: q (search text), search_fields (comma-separated).

to_spec() → pypaginate.domain.specs.SearchSpec | None

Convert to SearchSpec, or None if no query.

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].