Paginated Response Contract Return collection data with explicit navigation metadata instead of a bare array
Phase 15 - Filtering, Search, Sorting & Pagination Volume 04 - Professional Backend
v
v
v
Phase 15 turns an unbounded collection endpoint into a validated, queryable, stable, paginated API contract.
A paginated response needs a deliberate envelope Returning only Task[] forces the frontend to guess whether more data exists. TaskFlow adds metadata that directly supports numbered navigation and summary text.
{ "data": [ ... ], "meta": { "page": 2, "pageSize": 20, "totalItems": 143, "totalPages": 8, "hasPreviousPage": true, "hasNextPage": true } }
Calculate metadata centrally const totalPages = Math.ceil(totalItems / query.pageSize);
return { data: items, meta: { page: query.page, pageSize: query.pageSize, totalItems, totalPages, hasPreviousPage: query.page > 1, hasNextPage: query.page < totalPages, }, };
What if page is beyond the last page? There are several defensible contracts: return an empty data array with accurate metadata, clamp to the last page, or reject the page. TaskFlow uses the simplest explicit behavior: page remains what the client requested and data may be empty. The metadata tells the truth. Do not silently move the client to another page unless the API documents that policy.
COUNT(*) over a heavily filtered or joined dataset can become expensive. Numbered-page UX may justify it; infinite-scroll APIs often avoid exact totals. Product requirements and measurement determine whether totalItems belongs in the contract.
Paginated Response Contract matters because it changes a real boundary in TaskFlow. The goal is to understand the inputs, owner, observable output, and failure modes before adding more abstraction.
Restate the goal of “Paginated Response Contract” as one observable behavior. Write the success signal before touching code.
Trace the boundary map: query parameters → validated filter/sort → stable query → page/cursor → response metadata. Mark the one boundary this lesson changes.
Inspect the current repository state and record the exact files, route, table, or runtime involved. Avoid creating an abstraction before you can name the existing owner.
Implement the smallest vertical slice. Add one coherent change, run the narrowest verification command, and read the output before continuing.
Connect the slice to TaskFlow’s phase artifact: Task list API with filter/search/sort/page contract plus metadata and indexes justified by measured query patterns.. Verify behavior from the outside as a user or API client would.
Create one controlled failure that is safe to reproduce. Predict the symptom first, capture evidence, locate the earliest broken boundary, then fix only that cause.
Close the reference and rebuild or explain the core change from memory. Record what you would monitor or test before trusting the same change in production.
orderBy: [{ createdAt: "desc" }, { id: "desc" }],
take: limit + 1,
where: cursor ? {
OR: [
{ createdAt: { lt: cursor.createdAt } },
{ createdAt: cursor.createdAt, id: { lt: cursor.id } },
],
} : undefinedDo not copy this as a finished answer. Predict what each boundary does, type the smallest useful slice, run it, then compare the result with your prediction.
Return to the nearest observable boundary: input, network, process log, database, or rendered UI. Compare actual evidence with the predicted path.
Change one variable at a time and reproduce the original failure after the fix; otherwise you have correlation, not diagnosis.
Without copying the final source, create a second small scenario that applies “Paginated Response Contract” to a different TaskFlow resource or input. Write the acceptance criteria first, implement it, and provide the evidence that each criterion is satisfied.
Whitelist sortable fields and directions instead of interpolating arbitrary user input.
Use the smallest change that demonstrates this lesson. Stop after it works and capture evidence.Counting/filtering with different predicates so metadata lies
Predict the symptom before causing the failure. Then locate the earliest boundary where reality diverges from expectation.Why does this responsibility live here, what input does it trust, what output proves success, and what would go wrong if another layer owned it?
If your explanation is vague, repeat the boundary trace before moving on.Close the reference. Reproduce the core idea from memory or explain the exact request/data flow aloud. Then check your diff or notes for accidental shortcuts that bypass validation, authorization, error handling, or verification earned in earlier phases.