skills.rest
partme-ai
partme-aiOFFICIAL
Explore all skills by this author →
GitHub

api-doc-generator

Generate Markdown API documentation from Java and Kotlin Controller classes.

610|93|Updated Jan 16, 2026
Search Tags:#rest api#api documentation#spring boot#code scanning#documentation generator#interface documentation
One-click install
npx skills add https://github.com/partme-ai/full-stack-skills --skill api-doc-generator-partme-ai
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-doc-generator
Source: https://github.com/partme-ai/full-stack-skills/tree/main/skills/api-doc-generator
Command: npx skills add https://github.com/partme-ai/full-stack-skills --skill api-doc-generator-partme-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill automates the creation of comprehensive API documentation by scanning your project's code, extracting interface details, and generating standardized documents.

Core Features & Use Cases

  • Automated API Documentation: Scans Controller classes to identify API endpoints.
  • Information Extraction: Extracts request methods, URLs, parameters (path, query, body), and response structures.
  • Standardized Output: Generates documentation in Markdown using predefined Chinese or English templates.
  • Use Case: After developing a new set of REST APIs for your backend service, use this Skill to quickly generate an up-to-date API documentation file that can be shared with frontend developers and testers.

Quick Start

Use the api-doc-generator skill to generate API documentation for the entire project.

Frequently Asked Questions about api-doc-generator

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

FAQPage Schema
How do I generate API documentation from Spring Boot code?▼

Generating API documentation involves scanning Controller classes to extract API endpoints, request methods, URLs, and parameters, then formatting them into standardized Markdown documentation.

Can I extract REST API interface details automatically from my project?▼

Yes, you can automatically extract REST API interface details by scanning project code to identify Controller classes and pull out request methods, URLs, path and query parameters, and response structures.

Does this API documentation generator support Kotlin and Java projects?▼

Yes, this API documentation generator supports both Java and Kotlin projects, specifically targeting frameworks like Spring Boot to scan and extract interface information for standardized output.

What format is used for the generated REST API documentation?▼

The generated REST API documentation is output in Markdown format, utilizing predefined Chinese or English templates to standardize the extracted request and response details.

Why use a code scanning approach for interface documentation instead of manual entry?▼

Using a code scanning approach for interface documentation ensures your docs match the actual implementation by directly extracting URLs, parameters, and response structures from Controller classes, eliminating manual sync errors.

Related Skills

Explore More Software Engineering Skills→
JeongjjunaJeongjjuna

gen-controller

Generate Java/Spring Boot controller and RestDocs test classes from UseCase interfaces.

Community
Intermediate
copilot-ldcopilot-ld
1

libdoc

Render Markdown documentation into static HTML sites with Mustache templates.

Official
Advanced
rlagycksrlagycks
3

springboot-verification

Automate Spring Boot project verification with builds, static analysis, tests, and security scans.

Community
Intermediate
QunnnnQunnnn

go-swagger

Generate Swagger API documentation from annotated Go source code using swaggo/swag patterns.

Community
Intermediate