Phase 13 · Lesson 01

Error Taxonomy and API Contract

≈ 2 min core reading · 364 source/companion words
Learning contract

What you should be able to do after this

  • Explain Error Taxonomy and API Contract without relying on framework buzzwords.
  • Connect the lesson to the phase outcome: Create a stable application error model that separates expected domain/transport failures from unexpected faults and keeps diagnostics observable.
  • Reproduce the relevant behavior and verify it with evidence.
  • Diagnose at least one representative failure instead of guessing.
Figure 13.1 — TaskFlow boundary map
failure occurs
typed/application error
exception mapping
structured log
safe HTTP error
frontend recovery
This lesson belongs to Phase 13. Keep the full request/data path visible even when today's code changes only one box.
Instructor workflow: predict first → implement the smallest slice → run it → inspect evidence → break one assumption → diagnose → explain it back. Do not copy the whole code block before understanding the first failing boundary.

Error Taxonomy & API Contract Expected failures, unexpected faults, HTTP semantics, machine codes, and public error design

Phase 13 - Professional Error Handling Volume 04 - Professional Backend

Architecture milestone Failure occurs

↓

Classify meaning

↓

Choose safe status/code

↓

Return stable contract

Phase 13 creates one professional exception boundary and a correlation story that spans client response and server logs.

Not every failure is the same Professional error handling begins by classifying failures before choosing a status code or message. Treating every exception as a generic 500 makes the API hard to use. Treating every failure as a client mistake hides real server faults.

Category Example Expected handling

Invalid request blank title, malformed UUID 400 with validation details

Missing resource valid Task ID does not exist 404 with domain code

State conflict duplicate unique value / relation conflict 409

Authentication later missing/invalid token 401

Authorization later identity lacks permission 403

Unexpected fault bug, unavailable dependency, unknown exception 500 sanitized to client

Figure 1 - Expected failure vs unexpected fault Request enters system

↓

Can the application explain the failure safely?

↓

Yes -> stable 4xx response

↓

No -> log diagnostics internally

↓

Return sanitized 500

A client-facing API should expose actionable contract information without exposing server internals.

Status code is not the whole contract Two 404 responses can mean different application situations. A stable application error code lets clients distinguish them without parsing English text.

{ "statusCode": 404, "code": "TASK_NOT_FOUND", "message": "Task ... was not found.", "requestId": "7", "timestamp": "2026-09-18T...Z", "path": "/tasks/..." }

Human message vs machine code

Field Purpose

statusCode HTTP semantics; proxies, clients and tooling understand it

code Stable machine-readable application meaning

message Human-readable explanation

details Optional structured validation information

requestId Correlation between client failure and server log

timestamp When the server produced the error

path Which endpoint failed

Do not parse English messages

Frontend code should branch on statusCode or code, not on exact English wording such as message.includes("not found"). Messages can change for clarity; stable codes are the contract.

Error handling is a boundary concern Business services should explain domain failures. The global exception boundary should format those failures for HTTP. Database adapters should not dictate the public API. This separation prevents infrastructure-specific error text from becoming a client contract.

Executable lesson studio · errors

Now turn the explanation into engineering skill.

Error Taxonomy and API 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.

By the end, you should be able to

  • Explain Error Taxonomy and API Contract in terms of concrete inputs, ownership, outputs, and evidence.
  • Implement or reproduce the smallest TaskFlow slice that demonstrates this errors concept.
  • Diagnose one representative errors failure using observable evidence instead of trial-and-error.
Figure 13.1B — Mental model
failure
typed/domain error
exception mapping
HTTP envelope
client handling
Read left-to-right while implementing. When debugging, walk right-to-left until the first observed fact differs from your prediction.
Code-along sequence

One coherent change at a time

  1. 01

    Restate the goal of “Error Taxonomy and API Contract” as one observable behavior. Write the success signal before touching code.

  2. 02

    Trace the boundary map: failure → typed/domain error → exception mapping → HTTP envelope → client handling. Mark the one boundary this lesson changes.

  3. 03

    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.

  4. 04

    Implement the smallest vertical slice. Add one coherent change, run the narrowest verification command, and read the output before continuing.

  5. 05

    Connect the slice to TaskFlow’s phase artifact: Error taxonomy + NestJS mapping layer/filters + structured error response with request IDs.. Verify behavior from the outside as a user or API client would.

  6. 06

    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.

  7. 07

    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.

jsonStable client-facing error envelope
{
  "error": {
    "code": "TASK_NOT_FOUND",
    "message": "Task was not found",
    "requestId": "req_..."
  }
}

Do 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.

Verification

Prove the happy path

  1. Run the narrowest relevant command or request and require a clean exit/status.
  2. Inspect the boundary-specific evidence: terminal output, Network panel, database row/query plan, test report, container health, or deployment logs.
  3. Repeat the behavior once after the change so a one-off cached or stale result cannot masquerade as success.
Break it on purpose

Build debugging memory

  1. Returning raw exception messages/stacks
  2. Change one assumption in the errors example—identity, input, configuration, ordering, connectivity, or state—and predict the exact symptom before running it.
SymptomInvestigation path
Expected result does not appear

Return to the nearest observable boundary: input, network, process log, database, or rendered UI. Compare actual evidence with the predicted path.

A shortcut appears to fix it

Change one variable at a time and reproduce the original failure after the fix; otherwise you have correlation, not diagnosis.

Closed-reference challenge

Can you transfer the idea?

Without copying the final source, create a second small scenario that applies “Error Taxonomy and API Contract” to a different TaskFlow resource or input. Write the acceptance criteria first, implement it, and provide the evidence that each criterion is satisfied.

Explain-back

Answer these without reopening the solution

  1. What problem does Error Taxonomy and API Contract solve in TaskFlow, and what would be observably wrong without it?
  2. Which part of the errors boundary owns the decision, and which neighboring layer must not own it?
  3. What evidence proves the happy path instead of merely suggesting it worked?
  4. Name one realistic failure or abuse case and the first place you would inspect.
  5. If requirements doubled tomorrow, which part of this design should stay stable and which part is allowed to change?
Lesson studio

Turn the reading into skill

01

Do it

Inventory current TaskFlow failures and group them into validation, auth, forbidden, missing, conflict, infrastructure, and unexpected categories.

Use the smallest change that demonstrates this lesson. Stop after it works and capture evidence.
02

Break it safely

Returning raw exception messages/stacks

Predict the symptom before causing the failure. Then locate the earliest boundary where reality diverges from expectation.
03

Explain it back

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.
Exit ticket

Before marking complete

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.