Menu
基于OpenAPI规范生成API文档，支持Swagger UI和ReDoc展示
Instalar com Codex ou Claude Copie este prompt, cole no Codex, Claude ou outro assistente e deixe que ele revise a página da skill e instale para você.
简洁风格技能，禁止废话，采用caveman式简短直接的表达方式
个人文档管理技能，管理变更记录、方案设计Spec文档、测试报告等，统一存放在docs目录下
项目启动管理技能，支持Java Spring Boot和Vue项目的启动、重启、关闭操作，保持原有端口不变
方案调研技能，对方案设计、功能实现进行多方案比对分析，至少3个方案，建议5个左右的方案比对，包括业界标杆方案、大厂实现方案等
提供后端单元测试指导和生成能力，支持JUnit 5、Mockito等框架
代码审查技能，提供代码质量检查和改进建议
| name | common-api-doc |
| description | 基于OpenAPI规范生成API文档，支持Swagger UI和ReDoc展示 |
| trigger | 用户需要生成或更新API文档时 |
| disable-when | 项目未使用RESTful API或已有完善文档 |
| category | backend |
| tags | ["api","swagger","openapi","documentation"] |
根据代码或需求自动生成 OpenAPI/Swagger 文档，支持交互式文档界面。
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| sourceType | String | 是 | 来源类型（code/requirements） |
| source | String | 是 | 代码路径或需求描述 |
| outputFormat | String | 否 | 输出格式（yaml/json/html，默认 yaml） |
| serverUrl | String | 否 | API 服务地址 |
{
"status": "SUCCESS",
"openapiVersion": "3.0.3",
"outputFile": "openapi.yaml",
"endpoints": [
{"method": "GET", "path": "/api/users", "summary": "获取用户列表"},
{"method": "POST", "path": "/api/users", "summary": "创建用户"},
{"method": "GET", "path": "/api/users/{id}", "summary": "获取用户详情"}
],
"swaggerUiUrl": "http://localhost:8080/swagger-ui.html"
}
springdoc:
api-docs:
path: /api-docs
swagger-ui:
path: /swagger-ui.html
支持自定义模板和文档样式。