API文档生成器(生成即用·API文档)

SKILL开发
开发 未标注权限 许可证不明确
安装这个技能

按风格与端点,直接生成 API 文档(Markdown 或 OpenAPI)。 触发词:生成API文档

一句话选型结论

按资料字段整理

API文档生成器(生成即用·API文档)是开发类的 Agent Skill,安装方式未标注,权限级别未标注,许可证不明确,有可直接复制的安装命令。技能本质是给模型读的说明书,效果取决于模型与客户端;装完先用一个小任务验证,再放进正式流程。

分类开发 安装方式未标注 权限级别未标注权限 许可证许可证不明确
累计安装 未标注 本周 未标注
GitHub 星标 未标注 仓库 未标注
下载量 未标注 技能市场下载数
权限级别 未标注权限 安装前请确认风险范围
许可证 许可证不明确 未说明

安装

未标注
在支持 Skills 的客户端里执行,装完问一句「你有哪些技能」验证
skillhub install user_af163eaa/z-api-doc
  1. 1
    确认客户端支持

    确认你的客户端支持 Skills(Claude、Codex、Cursor 等),并升级到较新的版本。

  2. 2
    拿到技能文件

    执行上面的命令安装;也可以把仓库里的 SKILL.md 手动放进客户端的 skills 目录。

  3. 3
    刷新技能列表

    重新打开客户端,或刷新技能列表,让新放进来的技能被加载。

  4. 4
    验证是否生效

    问一句「你有哪些技能」,确认列表里出现它,再拿一个小任务试跑。

技能档案

开发
字段来自技能仓库与公开索引,中文说明由本站标注
作者 / 维护方user_af163eaa仓库 未标注 · 版本 未标注
宿主客户端未标注技能可被这些客户端加载
安装方式未标注安装包 community
权限级别未标注权限安装前请确认风险范围
许可证未说明许可证不明确,商用前请自行确认条款
仓库可用性available技能仓库当前是否可访问
最近核验2026-11-06上游最后核验时间 · 数据更新 2026-11-06
正文体量4.7 KBSKILL.md 原文大小,越大说明说明书写得越细

典型使用场景

3 类
按分类整理的常见用法,具体以 SKILL.md 为准
写代码与改 bug

按需求补代码、定位并修掉报错。

读仓库与生成改动

让模型读懂项目结构,再给出可落地的改动。

跑测试与排查故障

按现象排查问题,补测试用例并复跑。

选择建议

装之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 有可直接复制的安装命令,不用自己翻文档找入口。

先想清楚的地方

  • 没有标注权限级别,实际能做什么要装好后确认。
  • 许可证不明确,商用或二次分发前先到仓库确认条款。
  • 没有做站内核验,内容以作者仓库为准。
  • 技能只是说明书,实际效果取决于模型与客户端,装完先用小任务试一遍。

更适合

  • 需要在开发场景里给模型补一套做法的人。
  • 愿意先读一遍 SKILL.md、确认它会让模型做什么的人。

不太适合

  • 对许可证要求很严、必须明确可商用的人。
  • 只想装完就自动变强、不打算看说明书的人。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
技能权限级别安装方式累计安装宿主客户端安装命令
API文档生成器(生成即用·API文档)当前 未标注权限 未标注 未标注 未标注 有
技能审查员 浏览器控制 ClawHub 市场 877.9 万 OpenClaw 有
Vercel React 最佳实践 浏览器控制 GitHub 仓库 849.1 万 Codex、Claude、Cursor 有
GitHub 代码协作 联网访问 ClawHub 市场 763.3 万 OpenClaw 有
网页设计指南 联网访问 GitHub 仓库 668.6 万 Codex、Claude、Cursor 有
本体论 只读 ClawHub 市场 663.7 万 OpenClaw 有

SKILL.md 全文

4.7 KB
模型实际读到的说明书原文,来自技能仓库

API文档生成器(生成即用·API文档)

> 设计范式:触发 → 弹窗分步引导(模式/参数/确认)→ 直接落盘成品文件 → 预览精修。
> 适用:按风格与端点,直接生成 API 文档(Markdown 或 OpenAPI)。

★ 核心:输出模式选择器(主动弹窗确认)

Skill 激活后,第一步用交互式选项向用户确认输出模式,不靠猜词:
- ① 成品:用户提供真实数据/素材 → 直接生成可运行/可投稿的成品文件。
- ② 半填充模板:给部分数据、留占位符 → 半填充的可运行文件。
- ③ 模板:只给骨架 + 占位符 + 说明,用户自行填。
若用户已显式说"模板/教我"或"直接出/帮我画好/生成文件",直接走对应模式;若提供真实数据,自动偏成品并提示可切回模板。

触发词

「生成API文档」「写接口文档」「openapi文档」
示例:「给用户和订单两个接口出份Markdown文档」

参数弹窗(领域参数)

激活并选定模式后,弹窗确认以下参数(支持多选与条件分支):
- 风格:Markdown / OpenAPI 3
- 端点清单:粘贴 / 逐个填
- 含示例:请求/响应示例 是/否
- 鉴权说明:是 / 否

生成与落盘

按所选模式+参数,直接写出文件到用户指定/默认目录:
- 产出物:API 文档(端点/参数/响应码/示例)+ 可选 openapi.yaml。
- 成品模式规范:字体≥8pt、配色对比达标、含必要标注(误差棒/单位/图例)、导出路径明确、命名规范。

选型与说明(领域)

内部→Markdown轻量;跨团队/前端→OpenAPI可生成客户端;必含错误码表。

领域模板 / 产出示例

  • 端点块:METHOD /path | 参数表 | 200示例 | 4xx说明。
  • OpenAPI:paths+components.schemas结构。

异常处理(三级响应)

  • 需求模糊 → 弹窗反问关键项(用途/受众/格式/数据)。
  • 超出边界(需实时API/付费数据/联网抓取)→ 说明限制并转诊或给替代方案。
  • 数据/素材缺失 → 要示例数据,或先给占位结构(模板模式)。

反模式(8条)

  1. 不看模式直接写:必须先弹窗确认成品/半填充/模板三模式,不靠猜词。
  2. 一次性甩太多参数:用多选弹窗 + 条件分支 + 渐进披露,首屏只问必填项。
  3. 产出无明确路径:每次必须回显文件落盘位置,默认当前工作目录。
  4. 模板与成品混为一谈:两模式严格区分,模板留占位符、成品填实数据。
  5. 忽略异常处理:三级响应(模糊→反问 / 超界→转诊 / 缺料→要示例)必写。
  6. 风格飘忽:成品模式强制样式规范(字体≥8pt、对比达标、含必要标注)。
  7. 不回显参数:输出首段回显"模式+关键参数",避免跑偏。
  8. 超能力承诺:边界内交付,需实时API/付费数据/联网抓取时明说并转诊。

FAQ(10条)

  1. 和纯指南类 skill 区别? 本 skill 每次运行必产出可打开/可编辑的落地文件,不是只给建议。
  2. 弹窗在别的平台能用吗? WorkBuddy 内是真实多选卡片;其他平台 SkillHub 下载包退化为清晰多选文字,仍比被动猜词稳。
  3. 模板和成品怎么选? 想学方法/反复换数据用模板;赶投稿/工期用成品(给真实数据直接出图)。
  4. 产出文件在哪? 输出首段回显绝对路径,默认当前工作目录,可指定。
  5. 能改风格/配色吗? 参数弹窗可选配色预设、输出格式(md/docx/xlsx/html/png 等)。
  6. 不提供数据能出吗? 模板模式可不给数据,只给骨架+占位符+说明。
  7. 支持哪些输出格式? 见各 skill「产出物」说明,多为 md/docx/xlsx/html/py/png/svg。
  8. 中途出错怎么办? 异常处理三级响应会引导你补齐信息或转诊。
  9. 能一次出多个文件吗? 支持"多文件套装"(主文件+配套),弹窗可勾选。
  10. 怎么二次修改? 产出文件可直接编辑;或把修改点告诉 agent 重跑微调。

固定输出结构(5段)

  1. 模式与参数回显 2. 选型依据 3. 生成文件清单+绝对路径 4. 关键参数/样式说明 5. 使用与修改提示

常见问题

5 问
答案由本站依据条目字段整理
API文档生成器(生成即用·API文档)怎么安装?

在支持 Skills 的客户端里执行:skillhub install user_af163eaa/z-api-doc。安装方式为未标注。装完刷新技能列表或重开客户端。

API文档生成器(生成即用·API文档)支持哪些客户端?

资料没有标注宿主客户端,但只要客户端支持 Skills(Claude、Codex、Cursor 等),一般都能加载。

API文档生成器(生成即用·API文档)权限高吗,安全吗?

权限级别为未标注权限。安装前先看它会读取或写入哪些内容。

API文档生成器(生成即用·API文档)收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于技能本身和所用的模型或客户端,正式使用前按作者说明确认。

API文档生成器(生成即用·API文档)用什么许可证?

许可证标注为 未说明(许可证不明确)。商用或二次分发前请到仓库确认条款原文。

热门专题

按场景挑技能
全部专题 →

技能内容以作者仓库为准;分类、权限级别与许可证状态的中文说明为中文整理,最近核验 2026-11-06。