# Hyperwork API Scaffold

> API scaffolding — generate route/handler/schema/test skeletons for new endpoints, following existing project patterns.

- Skill: `samrom3/hyperwork-api-scaffold` (Agent Skill)
- Install (CLI): `npx skillmds@latest add samrom3/hyperwork-api-scaffold`
- Raw SKILL.md: https://api.skillmd.com/api/skills/samrom3/hyperwork-api-scaffold/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Integrations & APIs
- Author: samrom3 (https://skillmd.com/u/samrom3)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/samrom3/hyperwork-api-scaffold

---


# API Scaffold

**Use:** Tasks that create new API endpoints or services from scratch.

## Approach

1. Read existing endpoint files before writing anything — match patterns exactly.
2. Identify: router/handler pattern, request validation library, response shape, error format.
3. Scaffold in order: schema/types → handler → route registration → tests.
4. Tests: cover happy path + at least one 4xx (bad input) + one 4xx (not found/auth).

## Output Checklist

- Request schema with validation (not raw `req.body` — use zod/pydantic/joi per repo).
- Response type explicit — no `any` or `dict`.
- Error responses follow existing error shape (read existing handlers for format).
- Route registered in correct router/router group.
- OpenAPI/docstring annotation if repo uses them.

## Do / Don't

- DO: grep for an existing similar endpoint and copy its structure — consistency > novelty.
- DO: include auth middleware if all other routes have it.
- DON'T: invent new patterns — match what's there.
- DON'T: skip validation — unvalidated endpoints are a security boundary violation.
- DON'T: hardcode env vars — use config injection pattern from repo.