Does it support multilingual documentation?

Yes, the skill includes built-in templates for both English and Chinese, allowing you to choose the preferred language for your output.

Where are the generated documentation files saved?

By default, the skill creates or uses a /docs folder in your project root and saves the documentation as Markdown files.

Which programming languages and frameworks are supported?

The skill is primarily optimized for Java and Kotlin projects using the Spring Boot framework, specifically targeting @RestController and @Controller annotations.

Can it handle complex nested request and response objects?

Yes, the extraction process is designed to parse nested object structures to provide a clear view of the API's data contracts.

API Documentation Generator

Name: API Documentation Generator
Author: partme-ai

bypartme-ai

•

API Development

Generates comprehensive API documentation by scanning controller classes and extracting request/response information automatically.

The API Documentation Generator skill streamlines the documentation process for backend developers by automatically scanning Java or Kotlin Controller classes. It intelligently identifies RESTful endpoints, extracts detailed request parameters, headers, and response structures, and compiles them into standardized Markdown files. Supporting both English and Chinese templates, it ensures that your API documentation stays synchronized with your code, saving hours of manual writing while maintaining high standards for technical accuracy.

Key Features

01Automated file generation and organization within the project's /docs directory

02Automatic scanning of Spring Boot and Java/Kotlin Controller classes

03Support for complex request bodies and response object structures

04Multilingual support with standardized English and Chinese documentation templates

0537 GitHub stars

06Extraction of complete endpoint metadata including URL, methods, and parameters

Use Cases

01Generating quick reference guides for RESTful API services in Spring Boot projects

02Creating standardized technical documentation for frontend-backend handoffs

03Updating existing API docs after codebase refactors or new endpoint additions

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add partme-ai/full-stack-skills api-doc-generator

For use in Claude.ai and ChatGPT

Download Skill