Generates detailed API design documents with interface contracts, key code, and error codes.
npx skills add https://github.com/HACK-WU/skills --skill api-design-hack-wu
Please help me install this Agent Skill. Skill: api-design Source: https://github.com/HACK-WU/skills/tree/main/skills/api-design Command: npx skills add https://github.com/HACK-WU/skills --skill api-design-hack-wu
High-intent search queries and answers about installing and using this skill.
Provide the requirement and design documents as input, and the Skill extracts demo interfaces, confirms an interface list, then designs complete contracts, key code, and error codes stage by stage. Output is written as an INDEX.md plus per-module Markdown files.
Each endpoint needs method, path, authentication, permissions, path/query/body parameters, success and error responses, and realistic request/response examples. The Skill also adds key code designs for validation, state transitions, and permission checks.
No. It only designs behavior-critical code such as parameter validation, state transitions, core algorithms, and permission checks. Standard CRUD, framework configuration, and logging are explicitly left to developers.
No, demo interfaces are minimal sketches for illustrating design intent and may be incomplete or mismatched. The Skill requires independently redesigning each interface based on actual data structures, business scenarios, and constraints.
If a .requirements/config file defines a storage_path, documents go to {storage_path}/{feature}/api/ with an INDEX.md and one file per module. Otherwise the Skill asks and suggests .requirements/{feature}/api/ as the default.
shinnytechGenerate system architecture diagrams with Mermaid and PlantUML.
PanJasonConvert a PM Plan and repository context into a DESIGN.md document.
LerianStudioDefine component interfaces and data contracts before protocol selection.
686f6c61Generate API documentation with HTTP methods, routes, parameters, and schemas.
