Token导航 LogoToken导航

Agent Skill · 研究检索

api-documentation（API 文档）

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

api-documentation 是研究检索类 Agent Skill，可用宿主为 Codex、Claude、Cursor、Gemini CLI，通过GitHub 仓库获取，权限为需要联网；许可证信息还不明确，第三方扫描已通过，按安装量在研究检索类的 73,675 个 Skill 里排第 25,200。

总安装 3,830周安装 158GitHub Stars 35,731下载 1,251核验 2026-05-01
研究检索需要联网GitHub 仓库未标认证来源可访问许可证需确认审计通过CodexClaudeCursorGemini CLI

安装说明

本站只整理中文说明，不托管安装包，也不代用户安装。
GitHub
许可证
unknown

安装方式

通过对话安装

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

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

命令行安装

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

skills.shnpx skills
npx skills add https://github.com/sickn33/antigravity-awesome-skills --skill api-documentation

这个 Skill 是做什么的

研究检索类 Skill 主要解决「找资料、核对事实、把来源整理清楚」的问题，通常会让助手先检索再总结。

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

通过 npx skills add 命令从指定 GitHub 仓库安装并使用。

来源仓库内路径：skills/api-documentation

上手步骤

4 步
  1. 1

    确认自己的宿主工具

    公开资料标注支持 Codex、Claude、Cursor、Gemini CLI；先确认自己用的是其中之一，再按对应工具的 Skills 目录放置。

  2. 2

    拿到安装命令

    可以直接复制的命令是 npx skills add https://github.com/sickn33/antigravity-awesome-skills --skill api…；命令里的占位符换成自己的路径或密钥再执行。

  3. 3

    安装后重启宿主

    命令执行完要完全退出宿主工具再打开，让新装的 Skill 被重新扫描到，否则列表里可能看不到。

  4. 4

    按最小权限试用

    它需要需要联网，先在测试目录或测试账号里跑，确认没问题再放到正式项目。

常见问题

6 条

api-documentation 怎么安装？

在终端执行 npx skills add https://github.com/sickn33/antigravity-awesome-skills --skill api-documenta…。装完完全退出宿主工具再打开，让它重新扫描本地 Skill。

api-documentation 支持哪些 AI 工具？

公开资料标注支持 Codex、Claude、Cursor、Gemini CLI。其他工具只要能读取本地 Skill 目录，一般也能手动放进去，但要自己确认触发方式是否一致。

api-documentation 需要什么权限？

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

api-documentation 是免费的吗？

公开资料没有标注明确许可证，收费和商用限制都无法确认。正式使用前请到来源仓库核对授权说明。

api-documentation 用的人多吗？

公开数据是累计安装 3,830 次，近一周安装 158 次，下载 1,251 次，GitHub 35,731 星。这些数字来自第三方目录统计，只能当作热度参考，不代表质量或安全性。

api-documentation 安全吗？

第三方扫描结果为通过，但这只覆盖已知的静态检查项，不能替代自己读一遍源码和安装命令。

值得选的地方和要先想清楚的地方

值得选的地方

  • 同时适配 4 种工具，换客户端不用重新找替代品。
  • 第三方扫描已通过，常见的高风险行为没有命中。
  • 来源仓库有 35,731 星，维护活跃度相对可查。

先想清楚的地方

  • 许可证没有明确标注，能不能商用、能不能再分发都不确定。
  • 第三方目录整理，版本更新和行为细节以来源仓库为准。

适不适合你

更适合

  • 已经在用 Codex，想直接扩展它能力的人。
  • 需要处理研究检索类任务、又不想每次都手写提示词的人。

不太适合

  • 需要明确授权才能用到公司项目里的场景。
  • 需要厂商级技术支持和 SLA 的生产系统。

研究检索类 Skill 对比

6 个同类
Skill总安装GitHub 星权限许可证扫描
find-skills

寻找技能 · Codex、Claude

31,199,81316,486操作浏览器MIT有提醒
self-improving-agent

自我改进 Agent · OpenClaw

16,464,0023,396接触敏感数据MIT-0通过
soultrace

灵魂追踪 · Codex、Claude

7,588,94412需要联网未明确有提醒
self-improving

自我完善 · OpenClaw

6,829,2841,046需要联网MIT-0通过
microsoft-foundry

微软代工厂 · Codex、Claude

6,614,144764调用外部服务未明确有提醒
api-documentation

API 文档 · 本页

3,83035,731需要联网未明确通过

按安装量取同分类前几名；数字来自第三方目录统计，只作热度参考，不代表质量结论。

SKILL.md 原文

API Documentation Workflow

Overview

Specialized workflow for creating comprehensive API documentation including OpenAPI/Swagger specs, developer guides, code examples, and interactive documentation.

When to Use This Workflow

Use this workflow when:

  • Creating API documentation
  • Generating OpenAPI specs
  • Writing developer guides
  • Adding code examples
  • Setting up API portals

Workflow Phases

Phase 1: API Discovery

Skills to Invoke
  • api-documenter - API documentation
  • api-design-principles - API design
Actions
  1. Inventory endpoints
  2. Document request/response
  3. Identify authentication
  4. Map error codes
  5. Note rate limits
Copy-Paste Prompts
Use @api-documenter to discover and document API endpoints

Phase 2: OpenAPI Specification

Skills to Invoke
  • openapi-spec-generation - OpenAPI
  • api-documenter - API specs
Actions
  1. Create OpenAPI schema
  2. Define paths
  3. Add schemas
  4. Configure security
  5. Add examples
Copy-Paste Prompts
Use @openapi-spec-generation to create OpenAPI specification

Phase 3: Developer Guide

Skills to Invoke
  • api-documentation-generator - Documentation
  • documentation-templates - Templates
Actions
  1. Create getting started
  2. Write authentication guide
  3. Document common patterns
  4. Add troubleshooting
  5. Create FAQ
Copy-Paste Prompts
Use @api-documentation-generator to create developer guide

Phase 4: Code Examples

Skills to Invoke
  • api-documenter - Code examples
  • tutorial-engineer - Tutorials
Actions
  1. Create example requests
  2. Write SDK examples
  3. Add curl examples
  4. Create tutorials
  5. Test examples
Copy-Paste Prompts
Use @api-documenter to generate code examples

Phase 5: Interactive Docs

Skills to Invoke
  • api-documenter - Interactive docs
Actions
  1. Set up Swagger UI
  2. Configure Redoc
  3. Add try-it functionality
  4. Test interactivity
  5. Deploy docs
Copy-Paste Prompts
Use @api-documenter to set up interactive documentation

Phase 6: Documentation Site

Skills to Invoke
  • docs-architect - Documentation architecture
  • wiki-page-writer - Documentation
Actions
  1. Choose platform
  2. Design structure
  3. Create pages
  4. Add navigation
  5. Configure search
Copy-Paste Prompts
Use @docs-architect to design API documentation site

Phase 7: Maintenance

Skills to Invoke
  • api-documenter - Doc maintenance
Actions
  1. Set up auto-generation
  2. Configure validation
  3. Add review process
  4. Schedule updates
  5. Monitor feedback
Copy-Paste Prompts
Use @api-documenter to set up automated doc generation

Quality Gates

  • OpenAPI spec complete
  • Developer guide written
  • Code examples working
  • Interactive docs functional
  • Documentation deployed

Related Workflow Bundles

  • documentation - Documentation
  • api-development - API development
  • development - Development

Limitations

  • Use this skill only when the task clearly matches the scope described above.
  • Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
  • Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.

平台分布

Codex

33.71%
按下载量换算422

Claude

32.18%
按下载量换算403

Cursor

18.12%
按下载量换算227

Gemini CLI

9.66%
按下载量换算121

安全审计

Gen Agent Trust Hub

通过

Socket

通过

Snyk

通过

权限和风险

需要联网

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

安装前确认

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

继续浏览同类 Skills

更多研究检索 Skills（73,675）返回 Skills 目录

上一个 Skill

api-documentation（API 文档）

troykelly/claude-skills

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

下一个 Skill

api-documentation（API 文档）

wojons/skills

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