API Development Workflow
A repeatable slice for adding or changing an API route.
Start from the source docs and contract, then implement controller, DTO, service, tests, and public documentation together.
Source boundary
Source boundary: AutoCore current main 7a504f6e430c16d4fcb03ebdea3cc3fb7816df60, checked against immutable v1.0.0-rc.1 at 9edfb109f44cc80385784c694b96392cfc04e70f.
A route change requires contract review, validation behavior, auth/permission classification, error semantics, OpenAPI impact, and client compatibility review. Keep the source docs authoritative when a decision changes.
| Check | Source-backed expectation |
|---|---|
| Scope | Never add Swagger decorators merely to make documentation appear complete; document actual runtime behavior. |
| Evidence | Use placeholders, timestamps, release identity, route, status, and request ID where relevant. |
| Safe action | pnpm --filter @autocore/api typecheck |
| Stop condition | Unknown authorization, destructive impact, secret exposure, or conflicting evidence. |
Verification
Run the safe check, record its result, and compare the outcome with the documented contract. If the result depends on external configuration or provider availability, mark it as configuration-dependent rather than claiming a product guarantee.
pnpm --filter @autocore/api typecheck
Safety boundary
Examples are non-production and use placeholders. Do not deploy, reset, force a migration, create secrets, activate providers, replay sensitive work, or expose private data from this page.