Token导航 LogoToken导航TokenDH.com
研究检索需要联网github未标认证来源可访问clear审计未展示

api-documenterAPI 文档生成

Agent Skill

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

总安装

324

周安装

13

GitHub Stars

公开资料未说明

下载量

105
CodexClaudeCursorGemini CLI

安装说明

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

GitHub

来源数

2

许可证

MIT

最后核验

2026-05-01

来源状态

来源可访问

安装方式

通过对话安装

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

请帮我安装这个 Agent Skill:api-documenter(API 文档生成)
来源仓库:https://github.com/sidetoolco/org-charts
仓库路径:skills/api-documenter
安装命令:
npx skills add sidetoolco/org-charts --skill "api-documenter"
安装前请先检查当前环境是否支持对应 CLI,并向我确认将要执行的命令、安装目录、联网范围和文件读写权限;确认后再执行。

命令行安装

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

AgentSkills.tonpx skills
npx skills add sidetoolco/org-charts --skill "api-documenter"

简介

用于辅助 API 设计、接口文档、请求响应结构和服务集成说明。它适合让 Agent 梳理 endpoint、生成 OpenAPI 草稿、检查字段命名、整理错误码或辅助前后端联调。

  • 使用时需要确认真实业务语义、鉴权方式、分页和错误处理规则;涉及生成接口文档时,应避免凭空补字段,最好从现有代码、schema 或接口样例中提取事实。
  • 通过 npx skills add sidetoolco/org-charts --skill "api-documenter" 安装并使用。
  • 注意:生成的文档仅为参考草稿,需结合实际业务逻辑和测试用例进行验证和完善。
  • 适用宿主包括 Codex、Claude、Cursor、Gemini CLI,接入前应确认版本、权限和运行环境要求。

SKILL.md

name
api-documenter
description
Create OpenAPI/Swagger specs, generate SDKs, and write developer documentation. Handles versioning, examples, and interactive docs. Use PROACTIVELY for API documentation or client library generation.
license
Apache-2.0
metadata
author
edescobar
version
1.0
model-preference
haiku

Api Documenter

You are an API documentation specialist focused on developer experience.

Focus Areas

  • OpenAPI 3.0/Swagger specification writing
  • SDK generation and client libraries
  • Interactive documentation (Postman/Insomnia)
  • Versioning strategies and migration guides
  • Code examples in multiple languages
  • Authentication and error documentation

Approach

  1. Document as you build - not after
  2. Real examples over abstract descriptions
  3. Show both success and error cases
  4. Version everything including docs
  5. Test documentation accuracy

Output

  • Complete OpenAPI specification
  • Request/response examples with all fields
  • Authentication setup guide
  • Error code reference with solutions
  • SDK usage examples
  • Postman collection for testing

Focus on developer experience. Include curl examples and common use cases.

适合场景

01

用户想查找某类 Agent Skill 时

02

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

03

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

04

需要参考平台分布和安装热度时

能力概览

能力 1

按任务关键词查找相关 Skills

能力 2

展示可复制的安装命令

能力 3

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

能力 4

补充不同宿主或平台的使用分布数据

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

平台分布

Claude Code

30.92%
按下载量换算32

windsurf

20.84%
按下载量换算22

trae

17.2%
按下载量换算18

OpenCode

13.52%
按下载量换算14

Codex

8.31%
按下载量换算9

Antigravity

2.98%
按下载量换算3

安全审计

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

权限和风险

需要联网

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

安装前确认

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

来源信息

继续浏览同类 Skills