Spring Boot Openapi Documentation
giuseppe-trisciuoglio/developer-kit
Provides patterns to generate comprehensive REST API documentation using SpringDoc OpenAPI 3.0 and Swagger UI in Spring Boot 3.x applications.
Generates comprehensive README.md files for Spring Boot modules based on task specification requirements
Install Readme Generate
$ npx skills add Juncai22/spring-ai-agent-learning --skill readme-generate -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install Juncai22/spring-ai-agent-learning readme-generate --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/Juncai22/spring-ai-agent-learning.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/readme-generate .claude/skills/readme-generate && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "readme-generate" agent skill from https://github.com/Juncai22/spring-ai-agent-learning/tree/main/.agents/skills/readme-generate into .claude/skills/readme-generate/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-generate", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/Juncai22/spring-ai-agent-learning/tree/main/.agents/skills/readme-generateType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add Juncai22/spring-ai-agent-learning --skill readme-generate -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install Juncai22/spring-ai-agent-learning readme-generate --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/Juncai22/spring-ai-agent-learning.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.agents/skills/readme-generate .agents/skills/readme-generate && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "readme-generate" agent skill from https://github.com/Juncai22/spring-ai-agent-learning/tree/main/.agents/skills/readme-generate into .agents/skills/readme-generate/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-generate", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add Juncai22/spring-ai-agent-learning --skill readme-generate -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install Juncai22/spring-ai-agent-learning readme-generate --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/Juncai22/spring-ai-agent-learning.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.agents/skills/readme-generate .cursor/skills/readme-generate && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "readme-generate" agent skill from https://github.com/Juncai22/spring-ai-agent-learning/tree/main/.agents/skills/readme-generate into .cursor/skills/readme-generate/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-generate", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/Juncai22/spring-ai-agent-learning.git --path .agents/skills/readme-generate--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add Juncai22/spring-ai-agent-learning --skill readme-generate -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install Juncai22/spring-ai-agent-learning readme-generate --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/Juncai22/spring-ai-agent-learning.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.agents/skills/readme-generate .gemini/skills/readme-generate && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "readme-generate" agent skill from https://github.com/Juncai22/spring-ai-agent-learning/tree/main/.agents/skills/readme-generate into .gemini/skills/readme-generate/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-generate", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install Juncai22/spring-ai-agent-learning readme-generateInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add Juncai22/spring-ai-agent-learning --skill readme-generate -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/Juncai22/spring-ai-agent-learning.git skills-src && mkdir -p .github/skills && cp -r skills-src/.agents/skills/readme-generate .github/skills/readme-generate && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "readme-generate" agent skill from https://github.com/Juncai22/spring-ai-agent-learning/tree/main/.agents/skills/readme-generate into .github/skills/readme-generate/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-generate", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add Juncai22/spring-ai-agent-learning --skill readme-generate -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install Juncai22/spring-ai-agent-learning readme-generate --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/Juncai22/spring-ai-agent-learning.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.agents/skills/readme-generate .opencode/skills/readme-generate && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "readme-generate" agent skill from https://github.com/Juncai22/spring-ai-agent-learning/tree/main/.agents/skills/readme-generate into .opencode/skills/readme-generate/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-generate", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
readme-generate- GitHub stars
- 124
- Token cost
- ~2.2k tokens
- SKILL.md length
- 799 words
- Files
- 2 (incl. scripts)
- Skills in repo
- 4
- Repo updated
- First seen
- Licence
- Apache-2.0
At a glance
Generates comprehensive README.md files for Spring Boot modules based on task specification requirements
- Works in 6 steps: 模块功能介绍 (Module Functionality Description) → 接口文档 (API Documentation) → 使用示例 (Usage Examples) → …
- Tasks that involve Technical documentation
- SKILL.md covers When to Use, How to Use, Generated README Structure and Input Analysis Capabilities, plus 5 more sections
- Runs Python scripts from its folder; calls python
What it does
Readme Generate is an agent skill from Juncai22/spring-ai-agent-learning. Generates comprehensive README.md files for Spring Boot modules based on task specification requirements
Its SKILL.md is about 2.2k tokens, which your agent loads only when the skill is triggered. The skill folder holds 2 other files, including scripts (for example `scripts/readme_generator.py`).
It sits in Development, covering Technical documentation and Backend development. It works with Spring Boot. The licence is Apache-2.0.
When your agent uses it
- Tasks that involve Technical documentation
- Tasks that involve Backend development
Example prompts
- “Use the readme-generate skill to generate comprehensive README.md files for Spring Boot modules based on task specification requirements”
- “/readme-generate”
Requirements
- Python 3
Workflow steps
6 steps, taken from the step headings in SKILL.md.
What it can do on your machine
Read from SKILL.md and the folder at commit ba09fd5. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
Ships 1 file in scripts/ (Python), which the agent can run.
Shell commands in SKILL.md call:
python
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
Readme Generate loads about 2.2k tokens when it runs. Until then it costs about 30 tokens; SKILL.md has 799 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); the scripts in this folder are not scanned.
SKILL.md
The full file from Juncai22/spring-ai-agent-learning at commit ba09fd5, republished under its Apache-2.0 licence (© Juncai22). 799 words, ~2,167 tokens.
Download SKILL.mdSave it as
.claude/skills/readme-generate/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.- name
- readme-generate
- description
- Generates comprehensive README.md files for Spring Boot modules based on task specification requirements
README Generator
This skill automatically analyzes Spring Boot modules and generates comprehensive README.md files according to the specified format requirements, including module functionality, API documentation, usage examples, technical implementation, testing guidance, and important notes.
When to Use
Use this skill when you need to:
- Generate README.md files for new modules
- Update existing README.md files when module content changes
- Create consistent documentation across multiple modules
- Document API interfaces automatically
- Provide comprehensive module documentation for developers
How to Use
Generate README for a Module
Execute the README generator script to create comprehensive documentation:
python .Codex/skills/readme-generate/scripts/readme_generator.py <module_path> [output_file]Parameters:
module_path(required): Path to the Spring Boot module directoryoutput_file(optional): Custom output file path (default:{module_path}/README.md)
Examples:
# Generate for chat module-generate.md (creates basic/chat/README.md)
python .Codex/skills/readme-generate/scripts/readme_generator.py basic/chat
# Generate for tool module-generate.md with custom output
python .Codex/skills/readme-generate/scripts/readme_generator.py basic/tool custom_README.md
# Generate for image module-generate.md
python .Codex/skills/readme-generate/scripts/readme_generator.py basic/image
# Update existing README
python .Codex/skills/readme-generate/scripts/readme_generator.py graph/parallelGenerated README Structure
The skill generates README.md files that strictly follow the task specification:
1. 模块功能介绍 (Module Functionality Description)
- Automatically extracts module functionality from controller classes
- Generates comprehensive descriptions based on actual implementation
- Provides clear overview of module purpose and capabilities
2. 接口文档 (API Documentation)
- Complete API Coverage: All REST endpoints documented
- Path Information: Full endpoint paths with HTTP methods
- Parameter Details: All request parameters with default values
- Response Format: JSON response structure
- Feature Lists: Key capabilities and characteristics
3. 使用示例 (Usage Examples)
- HTTP Requests: Ready-to-use curl commands
- Parameter Examples: Default parameter values for testing
- Integration Examples: Different usage scenarios
- Tool Integration: Links to corresponding .http files
4. 技术实现 (Technical Implementation)
- Core Components: Key Spring Boot and Spring AI Alibaba components
- Configuration Details: Environment variables and configuration requirements
- Dependencies: Important Maven/Gradle dependencies
- Architecture Overview: Module structure and design patterns
5. 测试指导 (Testing Guidance)
- HTTP File Testing: Direct links to generated .http test files
- curl Commands: Command-line testing examples
- IDE Integration: IntelliJ IDEA and VS Code testing guidance
- Parameter Testing: Different parameter combinations
6. 注意事项 (Important Notes)
- Environment Setup: Required environment variables and configurations
- Network Requirements: Service connectivity requirements
- Character Encoding: UTF-8 support for international content
- Port Configuration: Default port usage and customization
- Common Issues: Troubleshooting guidance
Input Analysis Capabilities
The skill automatically analyzes:
Source Code Analysis
- Controller Classes: Extracts REST endpoints and methods
- Method Annotations: @GetMapping, @PostMapping, @RequestMapping patterns
- Parameter Extraction: @RequestParam with default values
- Comments and Javadoc: Method descriptions and documentation
Configuration Analysis
- pom.xml: Maven dependencies and project information
- application.yml/properties: Configuration details
- Main Application Classes: Application entry points
File Structure Analysis
- Existing README.md: Preserves current descriptions when available
- HTTP Test Files: Links to generated .http test files
- Directory Structure: Module organization and components
Generated Content Features
Automated Content Generation
- Dynamic Descriptions: Based on actual code implementation
- Smart Categorization: Automatic identification of module types
- Parameter Extraction: Complete parameter documentation with defaults
- URL Construction: Full endpoint URLs with parameters
Format Compliance
- Markdown Standards: Proper formatting and structure
- Chinese Support: Full UTF-8 support for Chinese content
- Link Generation: Automatic internal links to related files
- Code Blocks: Proper syntax highlighting for code examples
Consistency and Quality
- Standardized Structure: Consistent format across all modules
- Comprehensive Coverage: All aspects of the module documented
- Up-to-date Information: Based on current source code
- Professional Presentation: Clear and developer-friendly documentation
Show full SKILL.md (308 more words)Show less
Module Type Detection
The skill automatically identifies module types based on controller names:
- Chat Modules: AI对话功能
- Tool Modules: 工具调用功能
- Image Modules: 图像处理功能
- RAG Modules: RAG增强功能
- Advisor Modules: 对话增强功能
- Stream Modules: 流式处理功能
- Parallel Modules: 并行处理功能
- Vector Modules: 向量数据库功能
- Search Modules: 搜索功能
File Organization
Output Location
- Default:
{module_path}/README.md - Custom: User-specified path
- Backup: Existing README.md is backed up automatically
Integration with Existing Files
- Preserves: Existing descriptions and custom content
- Updates: Adds missing sections and updates content
- Backups: Creates backup of existing README.md before modification
Customization Options
Modify Generation Behavior
Edit scripts/readme_generator.py to customize:
- Module Type Detection: Add new module type patterns
- Content Templates: Modify section templates and formats
- Parameter Extraction: Enhance parameter analysis logic
- Description Generation: Improve automatic description creation
Extend Functionality
Add support for:
- Additional File Types: Analyze more configuration files
- Advanced Documentation: Include more technical details
- Integration Examples: Add framework-specific examples
- Testing Automation: Generate automated test scripts
Usage Scenarios
New Module Development
# After creating a new module-generate.md, generate documentation
python .Codex/skills/readme-generate/scripts/readme_generator.py basic/new-module-generate.mdModule Updates
# After modifying module-generate.md content, update documentation
python .Codex/skills/readme-generate/scripts/readme_generator.py basic/updated-module-generate.mdBatch Documentation
# Generate documentation for multiple modules
for module-generate.md in basic/*; do
if [ -d "$module" ]; then
python .Codex/skills/readme-generate/scripts/readme_generator.py "$module"
fi
doneIntegration with Development Workflow
Continuous Documentation
- Synchronization: Keep documentation in sync with code changes
- Automated Updates: Regenerate documentation after feature changes
- Quality Assurance: Ensure all modules have consistent documentation
Team Collaboration
- Onboarding: Helps new developers understand module functionality
- API Reference: Provides complete API documentation for all team members
- Testing Guidance: Facilitates testing and quality assurance
Notes
- The skill automatically creates backups of existing README.md files
- All generated content uses UTF-8 encoding for international character support
- Requires Python 3 with no external dependencies
- Supports complex Spring Boot application structures
- Preserves custom content while adding missing sections
- Links automatically to generated HTTP test files when available
Error Handling
Common issues and solutions:
- No Controllers Found: Ensure module contains REST controller classes
- Missing Dependencies: Verify Spring Boot and Spring AI dependencies
- Encoding Issues: All files are processed with UTF-8 encoding
- File Permissions: Ensure write permissions for target directory
- Complex Structures: Skill handles nested module structures automatically
© Juncai22, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
SKILL.md and 1 other file (scripts) in .agents/skills/readme-generate of Juncai22/spring-ai-agent-learning.
- SKILL.md
- scripts/readme_generator.py
Open the folder on GitHubat commit ba09fd5
Compare with similar skills
Readme Generate next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Readme Generate this skillJuncai22/spring-ai-agent-learning | 124 | — | ~2.2k | Automated safety check: Pass | Apache-2.0 | |
| Spring Boot Openapi Documentationgiuseppe-trisciuoglio/developer-kit | 357 | — | ~2.6k | Automated safety check: Notes | MIT | |
| Groovy 5 Developer Guideapache/grails-core | 2.9k | — | ~3k | Automated safety check: Pass | Apache-2.0 | |
| Bootui Java Developmentjdubois/boot-ui | 314 | — | ~1.3k | Automated safety check: Pass | Apache-2.0 | |
| Ij Debuggerxpinjection/test-driven-spring-boot | 112 | — | ~6.4k | Automated safety check: Pass | MIT | |
| Add Server Env Var for User Settinglobehub/lobehub | 83k | — | ~644 | Automated safety check: Pass | Custom licence |
Similar skills
Groovy 5 Developer Guide
apache/grails-core
Guidance for Groovy 5 work in Grails projects: syntax, closures, traits, DSLs, metaprogramming, Spock tests, static compilation and Java 21 integration.
Bootui Java Development
jdubois/boot-ui
A skill your agent uses when implementing, debugging, refactoring, or testing existing BootUI Java code, including framework-neutral engine logic, Spring MVC and WebFlux adapters, Quarkus runtime…
Ij Debugger
xpinjection/test-driven-spring-boot
Debugger-first runtime root-cause analysis for JVM code in IntelliJ IDEA.
Add Server Env Var for User Setting
lobehub/lobehub
Adds a server-side environment variable that sets the default for a user setting in LobeHub, wired from the env schema through server config to the user store and docs.
Domain Driven Design
rrezartprebreza/spring-boot-skills
A skill your agent uses when evolving aggregate invariants, value objects or domain events in an existing DDD-style Spring Boot 3 application, or when DDD is explicitly requested.
More from Juncai22/spring-ai-agent-learning
Web Research
Juncai22/spring-ai-agent-learning
A skill your agent uses for requests related to web research; it provides a structured approach to conducting comprehensive web research
Arxiv Search
Juncai22/spring-ai-agent-learning
Search arXiv preprint repository for papers in physics, mathematics, computer science, quantitative biology, and related fields, Instructions for searching arXiv papers using Python script and shell…
HTTP Generate
Juncai22/spring-ai-agent-learning
Generates HTTP request examples for Spring Boot Web interfaces according to task specification and saves them as .http files in module-generate.md directories
Related
Works with
Categories
Questions about Readme Generate
What does Readme Generate do?
Generates comprehensive README.md files for Spring Boot modules based on task specification requirements. Readme Generate is an agent skill from Juncai22/spring-ai-agent-learning.
When should I use Readme Generate?
Readme Generate fits situations like: tasks that involve Technical documentation; tasks that involve Backend development.
How do I install Readme Generate in Claude Code?
Run `npx skills add Juncai22/spring-ai-agent-learning --skill readme-generate -a claude-code`. Or copy the skill folder (.agents/skills/readme-generate in Juncai22/spring-ai-agent-learning) into .claude/skills/readme-generate in your project. Claude Code loads it when a task matches its description.
How do I install Readme Generate in Codex?
Run `npx skills add Juncai22/spring-ai-agent-learning --skill readme-generate -a codex`. Or copy the skill folder (.agents/skills/readme-generate in Juncai22/spring-ai-agent-learning) into .agents/skills/readme-generate in your project. Codex loads it when a task matches its description.
Can I use Readme Generate in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add Juncai22/spring-ai-agent-learning --skill readme-generate -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/readme-generate, .gemini/skills/readme-generate, .github/skills/readme-generate and .opencode/skills/readme-generate in your project.
What does Readme Generate need to run?
Going by SKILL.md and its folder, Readme Generate needs Python for the scripts in its folder and the command-line tools its instructions call (python). Our summary lists: Python 3.
Does Readme Generate access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is Readme Generate safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. The check reads SKILL.md only: the scripts in the folder are not scanned, so read them before running anything.
What licence does Readme Generate use?
Readme Generate is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Readme Generate use?
About 2.2k tokens (SKILL.md is roughly 8.7k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to Readme Generate?
Skills that share tags, products or a category with Readme Generate: Spring Boot Openapi Documentation (giuseppe-trisciuoglio/developer-kit, 357 stars), Groovy 5 Developer Guide (apache/grails-core, 2.9k stars), Bootui Java Development (jdubois/boot-ui, 314 stars) and Ij Debugger (xpinjection/test-driven-spring-boot, 112 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Readme Generate?
Juncai22 (a GitHub user) maintains it in Juncai22/spring-ai-agent-learning, which has 124 GitHub stars. The repository holds 4 skills in this directory. The repository was last updated on July 17, 2026.
Source: Juncai22/spring-ai-agent-learning on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.