commandby michaelkacher

Design Api

Design API contracts and data models

Installs: 0
Used in: 1 repos
Updated: 2d ago
$npx ai-builder add command michaelkacher/design-api

Installs to .claude/commands/design-api.md

Launch the api-designer-agent to create detailed API specifications.

Prerequisites:
- `docs/requirements.md` should exist
- `docs/architecture.md` should exist

The agent will create:
- `docs/api-spec.md` - Complete API documentation
- `docs/data-models.md` - TypeScript interfaces and validation rules
- Optionally `docs/openapi.yaml` - OpenAPI specification

This command is useful for:
- Defining the contract between frontend and backend
- Planning API endpoints before implementation
- Ensuring frontend and backend teams are aligned
- Generating API documentation

After completion, consider running:
- `/design-database` - Design database schema
- `/write-tests` - Write tests for the API (TDD)

Quick Install

$npx ai-builder add command michaelkacher/design-api

Details

Type
command
Slug
michaelkacher/design-api
Created
6d ago