Menu
The review-first prompt is selected by default. You can switch to a direct command or download a local copy.
Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
A direct command skips the review prompt. Inspect the source before running it.
npx skills add https://github.com/bage2014/study --skill common-api-docThe command stays on one line. Scroll horizontally to inspect it before copying.
Prefer a local copy? Download the files currently available to SkillsMP.
Showing SKILL.md
UI设计规范技能，提供设计系统、配色方案、排版规则、无障碍标准等专业UI设计指导
项目规范技能，提供项目结构、文档管理、代码忽略等方面的标准和最佳实践
MCP Apps项目规范 - 后端驱动UI渲染架构。所有页面由后端生成HTML通过MCP协议返回渲染。Invoke when developing or maintaining MCP Apps projects, especially when creating new pages, tools, or stores.
Based on SOC occupation classification
| 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": "获取用户详情"}
],
springdoc:
api-docs:
path: /api-docs
swagger-ui:
path: /swagger-ui.html
支持自定义模板和文档样式。