api-doc

Generate API documentation from Spring Boot controllers in Markdown, JSON, or Swagger YAML.

1|Updated Jan 26, 2026
One-click install
npx skills add https://github.com/xmx0632/claude-code-demo --skill api-doc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-doc
Source: https://github.com/xmx0632/claude-code-demo/tree/main/Skills-Collection/api-doc
Command: npx skills add https://github.com/xmx0632/claude-code-demo --skill api-doc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the generation of API documentation from Spring Boot controllers, saving time and ensuring docs stay in sync with code.

Core Features & Use Cases

  • Auto-detect RestController and Controller classes
  • Parse @RequestMapping and related annotations
  • Generate Markdown API docs with optional JSON or Swagger YAML exports
  • Export customizable sections and groupings for large projects

Quick Start

Run the tool against your Spring Boot project to generate API documentation.

Frequently Asked Questions about api-doc

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

FAQPage Schema
How do I auto-generate API documentation directly from Spring Boot controllers?

You can auto-generate API documentation from Spring Boot controllers by parsing @RestController, @Controller, and @RequestMapping annotations. This tool outputs Markdown by default and supports optional JSON or Swagger YAML exports.

What annotation types are supported when generating REST API docs for Spring Boot?

Generating REST API docs supports @RestController, @Controller, @RequestMapping, and related annotations, alongside Swagger annotations. It detects these classes automatically to produce structured Markdown, JSON, or Swagger YAML output.

Can I export Spring Boot API documentation as Swagger YAML or JSON instead of Markdown?

Yes, you can export Spring Boot API documentation as Swagger YAML or JSON instead of Markdown. The tool defaults to Markdown but provides optional JSON and YAML export formats for integration.

Does this tool work with Swagger annotations in Spring Boot controllers?

Yes, this tool works with Swagger annotations in Spring Boot controllers. It parses both Spring mapping annotations and Swagger annotations to generate comprehensive API documentation in multiple formats.

What is the best way to organize API documentation for large Spring Boot projects?

The best way to organize API documentation for large Spring Boot projects is using customizable sections and groupings. This tool supports exporting grouped API docs by parsing controllers to maintain structured Markdown or YAML.