Profile My skills Saved Collections Edit profile Submit a skill

API Contract Design

API Contract Design

onfire7777 6d5bf34 695 B Updated
Integrations & APIs

File contents

API Contract Design

Purpose: Keep controller APIs stable, scoped, and schema-validated.

  1. Parse request bodies and query parameters with zod.
  2. Require project scope for project data.
  3. Return precise error messages and HTTP codes.
  4. Keep response shapes predictable for the dashboard.

Checklist:

  • Input schemas exist.
  • Scope is enforced before reads/writes.
  • Errors fail closed.
  • Tests cover invalid input.

Positive example: reject negative event limit with HTTP 400. Negative example: list all memories without project scope.

Failure modes: unscoped reads, silent coercion, inconsistent response envelopes.

onfire7777/five-agent-dev-team/tree/main/packages/agents/skills/backend/api-contract-design commit 6d5bf34cf9

Browse category

Frequently asked questions

npx skillmds@latest add onfire7777/api-contract-design-2