weapp-api-design

Design OpenAPI 3.0 API specifications from user stories and architecture documents.

1|Updated Mar 11, 2026
One-click install
npx skills add https://github.com/hekinami/weapp-dev-workflow --skill weapp-api-design
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: weapp-api-design
Source: https://github.com/hekinami/weapp-dev-workflow/tree/main/skills/weapp-api-design
Command: npx skills add https://github.com/hekinami/weapp-dev-workflow --skill weapp-api-design

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about weapp-api-design

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate an OpenAPI 3.0 spec from user stories for a WeChat mini program backend?

Generating an OpenAPI spec from user stories involves extracting endpoint needs from feature documents and architecture notes, then mapping RESTful resources, JWT authentication, versioned paths, and pagination into a standardized YAML file.

What is the best way to design RESTful API endpoints for WeChat mini program interfaces?

Designing RESTful API endpoints for WeChat mini programs requires modeling resources from user stories, applying JWT bearer authentication, standardizing error schemas, and structuring versioned paths to ensure a coherent backend interface contract.

How do I align planned backend behavior with documented API interfaces?

Aligning backend behavior with documented interfaces requires turning product requirements and architecture notes into a consistent OpenAPI contract, preventing mismatches by defining resources, methods, parameters, and standardized error schemas before implementation.

Can I use user stories and architecture documents to plan WeChat mini program API pagination?

Yes, you can use user stories and architecture documents to plan WeChat mini program API pagination by extracting endpoint needs and applying RESTful resource modeling to produce a structured OpenAPI 3.0 specification with pagination design.

Do I need to provide architecture notes to generate a versioned OpenAPI YAML file?

Yes, providing architecture notes is required to generate a versioned OpenAPI YAML file, as the API design process aligns endpoint needs extracted from user stories with the architectural document to ensure consistent API contracts.