API Specification Skill

Overview

This skill generates comprehensive API documentation and a machine-readable OpenAPI 3.0 specification. It translates functional requirements from the SRS and architectural decisions from the HLD into a complete, implementation-ready API contract. The skill can run after 01-high-level-design completes and operates in parallel with 02-low-level-design and 04-database-design.

When to Use

• After 01-high-level-design has produced HLD.md in projects/<ProjectName>/<phase>/<document>/, which identifies system components and integration points.
• When SRS_Draft.md Section 3.2 provides the functional requirements that map to API endpoints.
• When the team needs a formal API contract before backend development begins.

Quick Reference