login
JackyST0

api-doc-generator

by @JackyST0 in AI & LLM
43
4
# Install this skill:
npx skills add JackyST0/awesome-agent-skills

Or install specific skill: npx add-skill https://github.com/JackyST0/awesome-agent-skills/tree/main/examples/api-doc-generator

# Description

Generate API documentation from source code, supporting REST APIs, GraphQL, and various documentation formats.

# SKILL.md

name: api-doc-generator
description: Generate API documentation from source code, supporting REST APIs, GraphQL, and various documentation formats.
license: CC0-1.0

API Doc Generator

根据代码生成 API 文档，支持 REST API、GraphQL 及多种文档格式。

Generate API documentation from source code, supporting REST APIs, GraphQL, and various documentation formats.

When to Use

当用户请求以下操作时使用此 skill：
- 生成 API 文档 / Generate API documentation
- 创建接口文档 / Create interface documentation
- 编写 API 说明 / Write API descriptions
- 生成 OpenAPI/Swagger 规范 / Generate OpenAPI/Swagger specs

Instructions

分析步骤 / Analysis Steps

  1. 识别 API 类型 - REST、GraphQL、RPC 等
  2. 提取端点信息 - URL、方法、参数
  3. 分析数据结构 - 请求/响应格式
  4. 识别认证方式 - API Key、OAuth、JWT 等
  5. 生成文档 - 按照标准格式输出

文档内容 / Documentation Content

每个 API 端点应包含：
- 端点路径 - URL 和 HTTP 方法
- 描述 - 功能说明
- 参数 - 路径参数、查询参数、请求体
- 响应 - 成功和错误响应示例
- 认证 - 认证要求

输出格式 / Output Formats

支持以下文档格式：
- Markdown（默认）- 使用 templates/api-doc.md 模板
- OpenAPI 3.0 YAML
- API Blueprint

Use templates/api-doc.md for Markdown output format.

标准模板 / Standard Template

## API 文档 / API Documentation

### 端点概览 / Endpoint Overview

| 方法 | 路径 | 描述 |
|------|------|------|
| GET | /api/resource | 获取资源列表 |

### 详细说明 / Details

#### [方法] /path

**描述**: ...

**请求参数**:
| 参数 | 类型 | 必需 | 描述 |
|------|------|------|------|

**请求示例**:
```json
{}

响应示例:

{}

## Examples

### 输入 / Input

```python
from fastapi import FastAPI, HTTPException
from pydantic import BaseModel

app = FastAPI()

class User(BaseModel):
    id: int
    name: str
    email: str

@app.get("/users/{user_id}")
async def get_user(user_id: int) -> User:
    """Get a user by ID."""
    if user_id <= 0:
        raise HTTPException(status_code=404, detail="User not found")
    return User(id=user_id, name="John", email="[email protected]")

@app.post("/users")
async def create_user(user: User) -> User:
    """Create a new user."""
    return user

输出 / Output

API 文档

端点概览

方法 路径 描述
GET /users/{user_id} 根据 ID 获取用户信息
POST /users 创建新用户

GET /users/{user_id}

描述: 根据用户 ID 获取用户信息

路径参数:
| 参数 | 类型 | 必需 | 描述 |
|------|------|------|------|
| user_id | integer | ✅ | 用户唯一标识符 |

响应 200 - 成功:

{
  "id": 1,
  "name": "John",
  "email": "[email protected]"
}

响应 404 - 未找到:

{
  "detail": "User not found"
}

POST /users

描述: 创建新用户

请求体:
| 字段 | 类型 | 必需 | 描述 |
|------|------|------|------|
| id | integer | ✅ | 用户 ID |
| name | string | ✅ | 用户姓名 |
| email | string | ✅ | 用户邮箱 |

请求示例:

{
  "id": 1,
  "name": "John",
  "email": "[email protected]"
}

响应 200 - 成功:

{
  "id": 1,
  "name": "John",
  "email": "[email protected]"
}

# README.md

Awesome Agent Skills

Awesome PRs Welcome License: CC0 GitHub Stars

🔍 在线搜索 Skills

Awesome Agent Skills

🤖 精选的 AI Agent Skills 列表，适用于 Cursor、Claude Code、GitHub Copilot 等 AI 编程工具。

Agent Skills 是 AI Agent 可以发现和使用的指令、脚本和资源包，让 AI 更好地完成特定任务。

English | 简体中文

快速开始

一键安装（推荐）

macOS / Linux:

# 交互式模式 - 支持安装、卸载、查看
curl -sL https://raw.githubusercontent.com/JackyST0/awesome-agent-skills/main/install.sh | bash

# 或直接安装到指定平台
curl -sL https://raw.githubusercontent.com/JackyST0/awesome-agent-skills/main/install.sh | bash -s -- -p cursor -a

# 卸载 Skills
curl -sL https://raw.githubusercontent.com/JackyST0/awesome-agent-skills/main/install.sh | bash -s -- -p cursor -u -s code-review

# 查看已安装的 Skills
curl -sL https://raw.githubusercontent.com/JackyST0/awesome-agent-skills/main/install.sh | bash -s -- -p cursor --list-installed

Windows (PowerShell):

# 下载并运行安装脚本
irm https://raw.githubusercontent.com/JackyST0/awesome-agent-skills/main/install.ps1 | iex

# 或者先下载再运行（推荐）
Invoke-WebRequest -Uri "https://raw.githubusercontent.com/JackyST0/awesome-agent-skills/main/install.ps1" -OutFile "install.ps1"
.\install.ps1                                    # 交互式模式
.\install.ps1 -Platform cursor -All              # 安装所有 Skills
.\install.ps1 -Platform cursor -Uninstall -All   # 卸载所有 Skills
.\install.ps1 -Platform cursor -ListInstalled    # 查看已安装

手动安装

# 克隆本仓库的示例
git clone https://github.com/JackyST0/awesome-agent-skills.git
cp -r awesome-agent-skills/examples/code-review ~/.cursor/skills/

# 或克隆官方 Skills
git clone https://github.com/anthropics/skills.git ~/.cursor/skills/anthropics

在线搜索

不想翻阅长列表？试试 在线搜索工具，支持按名称、描述、平台快速筛选！

目录

什么是 Agent Skills

Agent Skills 是一种让 AI Agent 更智能的方式。每个 Skill 包含：

  • SKILL.md - 核心说明文件，告诉 AI 如何使用这个技能
  • scripts/ - 可选的脚本文件
  • templates/ - 可选的模板文件
  • resources/ - 其他资源文件

Skills 可在多个平台使用：

平台 全局目录 项目目录
Cursor ~/.cursor/skills/ .cursor/skills/
Claude Code ~/.claude/skills/ .claude/skills/
GitHub Copilot ~/.copilot/skills/ .github/skills/
Windsurf ~/.windsurf/skills/ .windsurf/skills/
OpenAI Codex ~/.codex/skills/ .codex/skills/

如何使用

方式一：手动复制

# Cursor
cp -r my-skill ~/.cursor/skills/

# Claude Code
cp -r my-skill ~/.claude/skills/

# GitHub Copilot
cp -r my-skill ~/.copilot/skills/
# 或项目级
cp -r my-skill .github/skills/

方式二：Git Clone

# 克隆到全局目录
git clone https://github.com/example/my-skill.git ~/.cursor/skills/my-skill

💡 提示：全局 skills 对所有项目生效，项目级 skills 仅对当前项目生效。

📖 详细指南：查看 如何使用 Agent Skills

Skills 列表

官方资源

名称 描述 Stars 链接
Agent Skills 开放标准 Agent Skills 官方规范文档 - skill.md
Agent Skills 规范 SKILL.md 格式规范 - agentskills.io
anthropics/skills ⭐ Anthropic 官方 Agent Skills 仓库 57.6k GitHub
github/awesome-copilot GitHub 官方 Copilot 资源合集 - GitHub
Agent Skills 索引 社区 Skills 搜索引擎 - agent-skills.md

Skills 合集

名称 描述 Stars 链接
awesome-cursorrules ⭐ 最全面的 Cursor Rules 合集 37.5k GitHub
everything-claude-code ⭐ Claude Code 配置大全（agents/skills/hooks） 34.1k GitHub
awesome-claude-skills ⭐ Composio 维护的 Claude Skills 合集 27.7k GitHub
awesome-claude-code ⭐ Claude Code skills/hooks/插件合集 22.2k GitHub
openskills ⭐ 通用 Skills 加载器（npm 安装） 7.4k GitHub
awesome-claude-skills VoltAgent 维护的 Claude Skills 合集 4.4k GitHub
claude-skills Simon Willison 的 Claude Skills 文档 910 GitHub
claude-skills-collection 官方与社区 Skills 精选集合 408 GitHub
cursor-rules-and-prompts Cursor 规则与提示词集合 117 GitHub
claude-code-kit Claude Code 工具包，自动激活 skills 60 GitHub

开发工具

名称 描述 平台 链接
claude-code-security-review ⭐ AI 安全审查 GitHub Action（官方） Claude GitHub
trailofbits/skills ⭐ Trail of Bits 安全研究和审计 Skills Claude GitHub
playwright-skill Playwright 浏览器自动化测试 Skill Claude GitHub
gh-code-review GitHub PR 代码审查 Skill Copilot GitHub
skill-codex 将任务委派给 Codex 的 Skill Claude GitHub
skillset-example GitHub Copilot 扩展示例 Copilot GitHub
claude-code-skills 专业级 Skills 市场 Claude GitHub
code-review 智能代码审查示例 Skill All 示例
git-commit Git 提交信息生成示例 Skill All 示例
unit-test-generator 单元测试自动生成 Skill All 示例
api-doc-generator API 文档生成 Skill All 示例
debug-helper 代码调试助手 Skill All 示例

效率提升

名称 描述 平台 链接
claude-code-workflows 生产级开发工作流，自动化质量检查 Claude GitHub
claude-skills 20+ 生产力工具，含 8 个专家 Agent Claude GitHub
claude-code-skill-factory Skills 工厂，批量生成和部署 Skills Claude GitHub
changelog-generator 从 Git 提交自动生成 Changelog Claude ComposioHQ

DevOps

名称 描述 平台 链接
devops-claude-skills DevOps 工作流市场，含 Terraform/K8s Claude GitHub
devops-engineer DevOps 工程师 Skill，云基础设施管理 Claude claude-plugins.dev
ci-cd CI/CD 管道设计、优化和安全扫描 Claude claude-plugins.dev
claudekit-skills Docker/GCP/Cloudflare 部署和管理 Claude GitHub
claudebox Docker 容器化 Claude Code 开发环境 Claude GitHub

数据处理

名称 描述 平台 链接
d3-visualization D3.js 数据可视化 Skill Claude ComposioHQ
context-engineering 上下文工程和多 Agent 架构 Skills All GitHub

写作创作

名称 描述 平台 链接
doc-coauthoring ⭐ 文档协作撰写 Skill Claude 官方
internal-comms ⭐ 内部沟通文档生成 Skill Claude 官方
docx ⭐ Word 文档读写处理 Skill Claude 官方
pdf ⭐ PDF 文档处理 Skill Claude 官方
pptx ⭐ PPT 演示文稿生成 Skill Claude 官方
xlsx ⭐ Excel 表格处理 Skill Claude 官方

设计相关

名称 描述 平台 链接
frontend-design ⭐ 前端 UI 设计 Skill Claude 官方
brand-guidelines ⭐ 品牌设计规范 Skill Claude 官方
canvas-design ⭐ Canvas 画布设计 Skill Claude 官方
theme-factory ⭐ 主题样式工厂 Skill Claude 官方
algorithmic-art ⭐ 算法艺术生成 Skill Claude 官方
slack-gif-creator ⭐ Slack GIF 创建 Skill Claude 官方

🚧 发现更多优秀 Skills？提交你的发现 →

如何贡献

欢迎提交 PR！请遵循以下步骤：

  1. Fork 这个仓库
  2. 添加你的 skill 到对应分类
  3. 确保填写完整信息（名称、描述、平台、链接）
  4. 提交 Pull Request

贡献规范

  • 每个 skill 必须有清晰的描述
  • 链接必须有效且可访问
  • 优先收录开源项目
  • 请按字母顺序排列

详细指南请查看 CONTRIBUTING.md。

创建你自己的 Skill

基本结构：

my-skill/
├── SKILL.md          # 必需：说明文件
├── scripts/          # 可选：脚本
├── templates/        # 可选：模板
└── examples/         # 可选：示例

📁 查看示例：本仓库的 examples/ 目录包含 5 个可直接使用的示例 Skills。

📖 创建指南：查看 如何创建 Skill 了解详细步骤。

📋 规范文档：查看 SKILL.md 规范 了解格式标准和最佳实践。

Star History

Star History Chart

许可证

CC0

在法律允许的范围内，贡献者已放弃此作品的所有版权和相关权利。

# Related Skills

# Supported AI Coding Agents

This skill is compatible with the SKILL.md standard and works with all major AI coding agents:

⚡ Amp 🚀 Antigravity 🤖 Claude Code 🦀 Clawdbot 📝 Codex ▶️ Cursor 🤖 Droid 💎 Gemini CLI 🐙 GitHub Copilot 🪿 Goose 📊 Kilo Code 🔧 Kiro CLI 💻 OpenCode 🦘 Roo Code 🌲 Trae 🏄 Windsurf

Learn more about the SKILL.md standard and how to use these skills with your preferred AI coding agent.