Api Doc Generator

What it does

The Api Doc Generator skill helps AI agents automatically scan codebases for API endpoints, extract relevant details like request URLs, methods, parameters, and response information from interfaces, and generate standardized API documentation. It focuses specifically on identifying and documenting APIs defined through Controller classes and associated annotations. This skill is designed to streamline the process of creating API documentation, saving developers time and ensuring consistency.

When to use it

• When you need to quickly generate API documentation for a project with Java or Spring Boot controllers.
• To automate the creation of standardized API documentation from existing code.
• When documenting newly developed APIs or updating existing API documentation.
• For projects using @RestController, @Controller with @RequestMapping, or files ending in Controller.java or Controller.kt.

Key capabilities

• Scans project code for Controller classes and associated API interfaces.
• Identifies methods annotated with @GetMapping, @PostMapping, @PutMapping, @DeleteMapping, or @RequestMapping.
• Extracts request URL, method, parameters, and response information from identified interfaces.
• Generates standardized API documentation based on a predefined template.
• Saves generated documentation to the ./docs directory within the project.

Example prompts

• "Generate API documentation for my current project."
• "Scan this project for Controller classes and list the number of API interfaces found."
• "Create API documentation focusing on the UserController class."

Tips & gotchas

• Crucially, you must first scan the code to find API interfaces before generating documentation. The skill will not function correctly without an initial code scan.
• The skill specifically targets Java and Spring Boot projects using common Controller patterns. It may not work with other frameworks or languages.
• If no API interfaces are found during the scanning process, the skill will stop and provide a message indicating potential issues with the project structure or annotations.