weapp-api-design
CommunityTurn user stories into OpenAPI specs
Authorhekinami
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill turns product requirements and architecture notes into a consistent API contract, reducing guesswork and preventing mismatches between planned backend behavior and documented interfaces.
Core Features & Use Cases
- Interface Discovery: Extracts endpoint needs from User Story documents and aligns them with the architecture document.
- RESTful API Design: Structures resources, methods, parameters, responses, authentication, and pagination into a coherent API plan.
- OpenAPI Generation: Produces a versioned OpenAPI 3.0 specification for downstream backend and frontend implementation.
- Use Case: A team defining a WeChat mini program backend can use this Skill to convert feature stories into a shared API document before implementation begins.
Quick Start
Ask the skill to review the relevant user stories and architecture notes, then generate the OpenAPI 3.0 YAML file at docs/design/api/openapi.yaml.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 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: weapp-api-design Download link: https://github.com/hekinami/weapp-dev-workflow/archive/main.zip#weapp-api-design Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 536,000+ vetted skills library on demand.