Phase 05 · Lesson 06

PowerShell API Testing and Contracts

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

What you should be able to do after this

  • Explain PowerShell API Testing and Contracts without relying on framework buzzwords.
  • Connect the lesson to the phase outcome: Design HTTP APIs using resources, methods, status codes, idempotency, errors, caching semantics, and versionable contracts.
  • Reproduce the relevant behavior and verify it with evidence.
  • Diagnose at least one representative failure instead of guessing.
Figure 5.6 — TaskFlow boundary map
Client intent
HTTP method + URI
headers/body
server processing
status + response representation
client state transition
This lesson belongs to Phase 05. 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.

FULL_STACK_DEVELOPER_2026_COMPLETE - Phase 05 PowerShell API Testing and Contracts

VOLUME 02 - FRONTEND + BACKEND FOUNDATIONS

PowerShell API Testing and Contracts Exercise TaskFlow HTTP directly before any browser integration

HTTP is the contract between independent programs.

REQUEST HTTP Client TaskFlow API

PowerShell / browser / later Next.js NestJS + Fastify RESPONSE

method + target + headers + optional body

status + headers + optional body

Figure - HTTP request/response exchange. Phase 05 studies the protocol before Phase 06 introduces a browser cross-origin call.

Book 6 of Phase 05

FULL_STACK_DEVELOPER_2026_COMPLETE - Phase 05 PowerShell API Testing and Contracts

Test the API without a frontend A backend should be independently testable. If every API test requires clicking through the UI, frontend bugs and API bugs become tangled. PowerShell gives us a direct client so we can see the raw contract before Phase 06 adds Next.js.

Start the server From: taskflow\apps\api

Terminal
pnpm run start:dev

GET the collection PowerShell

Invoke-RestMethod -Method Get -Uri 'http://127.0.0.1:4000/todos'

GET one resource PowerShell

Invoke-RestMethod -Method Get -Uri 'http://127.0.0.1:4000/todos/1'

POST a new Todo PowerShell

$body = @{ title = 'Connect Next.js later' } | ConvertTo-Json

Invoke-RestMethod ` -Method Post ` -Uri 'http://127.0.0.1:4000/todos' ` -ContentType 'application/json' ` -Body $body

PowerShell line continuation uses the backtick. Avoid trailing spaces after the backtick because they can break continuation. You can also place the command on one line when troubleshooting.

PATCH an existing Todo PowerShell

$body = @{ completed = $true } | ConvertTo-Json

Invoke-RestMethod ` -Method Patch ` -Uri 'http://127.0.0.1:4000/todos/1' ` -ContentType 'application/json' ` -Body $body

DELETE and inspect status PowerShell - Invoke-WebRequest is useful when you want response metadata

FULL_STACK_DEVELOPER_2026_COMPLETE - Phase 05 PowerShell API Testing and Contracts

$response = Invoke-WebRequest ` -Method Delete ` -Uri 'http://127.0.0.1:4000/todos/2'

$response.StatusCode

Invoke-RestMethod conveniently deserializes JSON. Invoke-WebRequest exposes more response metadata directly. Choose based on what you are trying to observe.

Build a contract table while testing Request Expected success Expected content

Code
GET /todos                                    200 OK                                Array of Todo representations

GET /todos/1 200 OK One Todo representation

Code
POST /todos                                   201 Created                           Created Todo representation
Code
PATCH /todos/1                                200 OK                                Updated Todo representation

DELETE /todos/2 204 No Content No response content

Code
GET /todos/999                                404 Not Found                         Structured Nest error representation

Verification habit

Write down the expected method, path, status and response shape before you send the request. Then compare expectation to observation. This is much more educational than repeatedly clicking Send until something looks right.

Official source notes Primary protocol reference: RFC 9110 - HTTP Semantics (RFC Editor). Supplemental developer reference: MDN HTTP Reference and HTTP Request Methods. Nest-specific routing and status behavior reference: NestJS Controllers documentation.

This phase teaches HTTP semantics independent of a specific transport version. HTTP/2 and HTTP/3 change framing and transport details, while request methods, target resources, headers, status codes and representation semantics remain the important application-level concepts for this course.

Executable lesson studio · testing

Now turn the explanation into engineering skill.

Tests are executable behavioral contracts. Good tests protect meaningful invariants and failure cases, not implementation trivia.

By the end, you should be able to

  • Explain PowerShell API Testing and Contracts in terms of concrete inputs, ownership, outputs, and evidence.
  • Implement or reproduce the smallest TaskFlow slice that demonstrates this testing concept.
  • Diagnose one representative testing failure using observable evidence instead of trial-and-error.
Figure 5.6B — Mental model
behavior contract
arrange
act
assert
regression signal
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 “PowerShell API Testing and Contracts” as one observable behavior. Write the success signal before touching code.

  2. 02

    Trace the boundary map: behavior contract → arrange → act → assert → regression signal. 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: A written TaskFlow API contract for tasks with request/response examples and deliberate error semantics.. 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.

tsAssert behavior that matters to the user/domain
it("rejects deleting another member's task", async () => {
  const response = await asUser(bob).delete(`/tasks/${aliceTask.id}`);
  expect(response.status).toBe(403);
  expect(await taskStillExists(aliceTask.id)).toBe(true);
});

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. Encoding actions into routes when resource semantics are clearer
  2. Change one assumption in the testing example—identity, input, configuration, ordering, connectivity, or state—and predict the exact symptom before running it.
SymptomInvestigation path
Test passes alone but fails in suite

Look for shared database state, timers, globals, unordered execution, or missing cleanup before adding retries.

Mock-heavy test gives false confidence

Move the highest-risk boundary to an integration test with the real adapter/database.

Closed-reference challenge

Can you transfer the idea?

Without copying the final source, create a second small scenario that applies “PowerShell API Testing and Contracts” 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 PowerShell API Testing and Contracts solve in TaskFlow, and what would be observably wrong without it?
  2. Which part of the testing 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

Write an error envelope that the frontend can parse consistently.

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

Break it safely

Encoding actions into routes when resource semantics are clearer

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.