planning-api-design

Community

Design per-story APIs before implementation.

Authorgleeb
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill prevents contract drift and rework by producing a story-scoped API specification that matches the Planning Hub’s architecture and consumed contracts.

Core Features & Use Cases

  • Story-scoped API surface analysis: Extracts endpoints needed for a single user story from its acceptance criteria and (optionally) its hld.md component mapping.
  • Contract-aligned contract design: Drafts request/response schemas, auth requirements, and error cases using consumed contracts as the source of truth.
  • Review-ready specification output: Produces plan/user-stories/US-NNN-name/api.md and returns a completion summary after sparring with the user.

Quick Start

Use the planning-api-design skill to create the API spec for a single user story by updating its plan/user-stories/US-NNN-name/api.md based on story.md, plan/system-architecture.md, consumed contracts, and (if available) hld.md.

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: planning-api-design
Download link: https://github.com/gleeb/ai-registry/archive/main.zip#planning-api-design

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.