api-doc-generator

How to use this skill

Scan code for API endpoints, extract interface details, and generate standardized documentation. Do NOT trigger for generic documentation requests without explicit API/interface mention.

Workflow

1. Scan Code - Check current project or specified objects for Controller classes and API interfaces
2. Extract Information - Scan interfaces to collect request URL, method, parameters, and response information
3. Generate Documentation - Create API documentation following the standard template
4. Save Output - Save documentation to ./docs directory in the current project

Step-by-Step Process

Step 1: Scan Code for Interfaces

CRITICAL: Before generating any documentation, you MUST scan the code to find API interfaces.

1. Identify Target:
   • Ask user if they want to scan the entire project or specific Controller classes