Token导航 LogoToken导航TokenDH.com
中转站排行榜
待分类需要联网github未标认证来源可访问许可证需确认审计未展示

api-docs（API 文档）

Agent Skill

用于辅助 API 设计、接口文档、请求响应结构和服务集成说明。它适合让 Agent 梳理 endpoint、生成 OpenAPI 草稿、检查字段命名、整理错误码或辅助前后端联调。使用时需要确认真实业务语义、鉴权方式、分页和错误处理规则；涉及生成接口文档时，应避免凭空补字段，最好从现有代码、schema 或接口样例中提取事实。

总安装

198

周安装

8

GitHub Stars

33,923

下载量

62
CodexClaudeCursorGemini CLI

安装说明

本站只整理中文说明和来源信息，不托管安装包，也不代用户安装。

GitHub

来源数

2

许可证

unknown

最后核验

2026-05-01

来源状态

来源可访问

安装方式

通过对话安装

复制提示词发给支持本地命令或 Skills 的 AI 助手，先确认命令和权限，再让它执行。

请帮我安装这个 Agent Skill：api-docs（API 文档）
来源仓库：https://github.com/ruvnet/ruflo
仓库路径：skills/api-docs
安装命令：
npx skills add https://github.com/ruvnet/ruflo --skill api-docs
安装前请先检查当前环境是否支持对应 CLI，并向我确认将要执行的命令、安装目录、联网范围和文件读写权限；确认后再执行。

命令行安装

复制命令到本机终端执行。该命令会通过 npx skills 从第三方来源获取 Skill；本站只展示命令，不托管安装包，也不自动执行。

skills.shnpx skills
npx skills add https://github.com/ruvnet/ruflo --skill api-docs

简介

用于辅助 API 设计、接口文档和请求响应结构梳理。

  • 适合生成 OpenAPI 草稿、检查字段命名或整理错误码。
  • 使用时需确认真实业务语义、鉴权方式和错误处理规则。适用宿主包括 Codex、Claude、Cursor、Gemini CLI，接入前应确认版本、权限和运行环境要求。
  • 避免凭空补字段，应优先从现有代码或接口样例中提取事实。
  • api-docs 属于待分类类 Skill，可作为该场景下的辅助能力补充。

SKILL.md

name
api-docs
description
Generate API documentation from source code with JSDoc and OpenAPI support
argument-hint
<source-path>
allowed-tools
Bash(npx *) mcp__claude-flow__hooks_worker-dispatch Read Write Grep

Generate API documentation from TypeScript/JavaScript source:

  1. Scan exports: Find all public functions, classes, and interfaces
  2. Extract JSDoc: Parse @param, @returns, @throws, @example annotations
  3. Generate missing docs: Add JSDoc for undocumented public APIs
  4. OpenAPI spec: For HTTP endpoints, generate OpenAPI 3.0 definitions

Dispatch via MCP: mcp__claude-flow__hooks_worker-dispatch({ trigger: "document", scope: "api" })

Conventions:

  • Every public export must have a JSDoc comment
  • Include @param with type and description
  • Include @returns with type and description
  • Include @throws for known error conditions
  • Include @example for non-obvious usage

适合场景

01

用户想查找某类 Agent Skill 时

02

需要根据任务场景推荐可安装能力包时

03

需要对比不同来源的安装命令和来源信息时

能力概览

能力 1

按任务关键词查找相关 Skills

能力 2

展示可复制的安装命令

能力 3

保留来源站点、仓库和原始说明，方便继续核验

安装后应在对应宿主中按原始 README 的触发条件使用；具体调用方式请以来源页面和 README 为准。

平台分布

Codex

37.34%
按下载量换算23

Claude

27.54%
按下载量换算17

Cursor

16.96%
按下载量换算11

Gemini CLI

9.77%
按下载量换算6

安全审计

暂无安全审计结果可展示。

权限和风险

需要联网

该 Skill 可能需要联网访问来源站点、仓库或外部 API；具体网络访问范围需要结合源码和 README 复核。

安装前确认

本站仅展示第三方公开信息，不托管安装包，不提供自动安装或运行环境。安装前应自行审查源码、依赖和命令行为。当前只有一个来源，正式发布前建议补源仓库或其他目录站核验。

来源信息

GitHub 仓库

github.com

/ruvnet/ruflo

SKILL.md 来源

github.com

/ruvnet/ruflo/tree/main/skills/api-docs

skills-sh

skills.sh

/ruvnet/ruflo/api-docs

继续浏览同类 Skills

更多待分类 Skills（11,209）返回 Skills 目录

上一个 Skill

api-design（API 设计）

用于辅助 API 设计、接口文档、请求响应结构和服务集成说明。它适合让 Agent 梳理 endpoint、生成 OpenAPI 草稿、检查字段命名、整理错误码或辅助前后端联调。使用时需要确认真实业务语义、鉴权方式、分页和错误处理规则；涉及生成接口文档时，应避免凭空补字段，最好从现有代码、schema 或接口样例中提取事实。

下一个 Skill

api-evolution-manager（API evolution manager 文档）

用于辅助 API 设计、接口文档、请求响应结构和服务集成说明。它适合让 Agent 梳理 endpoint、生成 OpenAPI 草稿、检查字段命名、整理错误码或辅助前后端联调。使用时需要确认真实业务语义、鉴权方式、分页和错误处理规则；涉及生成接口文档时，应避免凭空补字段，最好从现有代码、schema 或接口样例中提取事实。