BEGINNER • API Foundations and HTTP
Endpoint Design Lab for customer profile service #21
This lesson targets improve observability coverage in a realistic customer profile service workflow. You will practice commands: node server.js | app.get('/route', handler) | npm init -y. The code example is specific to backend API engineering tasks for this lesson objective.
Code Example
import { z } from "zod";
const createUserSchema = z.object({
email: z.string().email(),
password: z.string().min(8),
role: z.enum(["user", "admin"]).default("user"),
});
export function parseCreateUser(payload: unknown) {
const result = createUserSchema.safeParse(payload);
if (!result.success) {
return {
ok: false,
error: result.error.issues.map((issue) => issue.message),
};
}
return { ok: true, data: result.data };
}
console.log("Try endpoint with:", "app.get('/route', handler)");Commands & References
- node server.js
- app.get('/route', handler)
- npm init -y
Lab Steps
- Prepare environment using: node server.js
- Implement endpoint or middleware for this scenario.
- Test positive/negative cases and inspect response contracts.
- Document one reliability or security improvement.
Exercises
- Add one edge-case validation and return clear error details.
- Improve one endpoint to be idempotent and test retries.
- Write one test case proving the expected API behavior.