api-spec-generator

Generate and update RESTful API specification documents from database schemas and use cases.

Updated Aug 15, 2026
One-click install
npx skills add https://github.com/jacksonlee-tw/mystock-vue --skill api-spec-generator-jacksonlee-tw
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-spec-generator
Source: https://github.com/jacksonlee-tw/mystock-vue/tree/main/mystock-analysis/.github/skills/api-spec-generator
Command: npx skills add https://github.com/jacksonlee-tw/mystock-vue --skill api-spec-generator-jacksonlee-tw

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing and maintaining RESTful API specification documents by hand is slow and error-prone, and specs quickly drift out of sync with actual API implementations. This Skill automates the creation and updating of standardized API spec documents so documentation always matches the code. ## Core Features & Use Cases - Template-Based Generation: Applies a project-standard API spec template to produce complete documents with CRUD endpoints, request/response examples, validation rules, and error code definitions. - Flexible Input Sources: Accepts database table schemas (SQL DDL), Use Case documents, verbal descriptions, or existing Java Entity/DTO/Controller code as input. - Diagram Generation: Produces Mermaid architecture diagrams, ER diagrams, and sequence diagrams for CRUD, batch, and pagination flows. - Update Mode: Synchronizes existing spec documents when endpoints are added, modified, or deleted, marking changes with status indicators and bumping the document version. - Use Case: A backend developer adds a new query parameter to an employee management endpoint in a Spring Boot project and asks the AI to update the API spec; the Skill reads the template, updates only the affected sections, and increments the document version. ## Quick Start Ask the AI to generate an API specification document for your module based on its database table structure or use case description.

Frequently Asked Questions about api-spec-generator

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

FAQPage Schema
How do I generate a RESTful API specification document automatically?▼

Provide a database table schema, use case document, or verbal module description, and the Skill applies a standard template to produce a complete spec with endpoints, request/response examples, validation rules, and error codes.

How to keep API documentation in sync with code changes?▼

Use the update mode: when endpoints are added, modified, or deleted, the Skill reads the existing spec, updates only affected sections, marks changes with status indicators, and increments the document version number.

What inputs can be used to create an API spec?▼

The Skill accepts SQL DDL table definitions, use case requirement documents, plain verbal descriptions, Java Entity or DTO source code, and existing Spring Controller code as input sources.

Does it support Spring Boot and JPA conventions?▼

Yes, generated specs follow Spring Boot 3 and JPA/Hibernate conventions, including Spring Data pagination structures, standard validation annotations like @NotBlank and @Size, and layered Controller/Service/Repository architecture.

What diagrams are included in the generated API specification?▼

The Skill generates Mermaid diagrams including a system architecture graph, an entity-relationship diagram from table associations, and sequence diagrams for standard CRUD, batch processing, and paginated query flows.