vibe-api-docs

vibe-api-docs is a skill for Claude Code from xushuodasd/VIBE-Claude-Plugin. It costs 22 tokens per session (2,203 once invoked), scanned A, original, MIT.

An API documentation workflow for describing how software services communicate, including their URLs, inputs, outputs, errors, and access rules. It can produce Swagger/OpenAPI, Postman, and internal documentation.

In plain words
What is it for?
Use it to inspect a project, list its API endpoints, group them by function, document authentication and errors, and create or update API reference files.
Why use it?
It turns scattered information in source code and design documents into an organized reference. This helps developers understand and test an API without guessing how its requests and responses work.

Skill for Claude Code

Written for Claude Code: shipped in a Claude Code plugin.

Part of the vibe-claude-plugin plugin — 25 skills, 1 command shipped together

Good fit Use it to inspect a project, list its API endpoints, group them by function, document authentication and errors, and create or update API reference files.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/xushuodasd/vibe-claude-plugin/vibe-api-docs
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add xushuodasd/VIBE-Claude-Plugin --skill vibe-api-docs
Clone the repo
git clone --depth 1 https://github.com/xushuodasd/VIBE-Claude-Plugin

Made for: Claude Code.

Or install vibe-claude-plugin, the plugin that ships this one along with the rest of its 25 skills, 1 command.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for vibe-api-docs

README.md
[![agentmods](https://agentmods.dev/badge/skills/xushuodasd/vibe-claude-plugin/vibe-api-docs/github.svg)](https://agentmods.dev/skills/xushuodasd/vibe-claude-plugin/vibe-api-docs)
Your own site
<a href="https://agentmods.dev/skills/xushuodasd/vibe-claude-plugin/vibe-api-docs"><img src="https://agentmods.dev/badge/skills/xushuodasd/vibe-claude-plugin/vibe-api-docs/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for vibe-api-docs

Your own site · 80×15
<a href="https://agentmods.dev/skills/xushuodasd/vibe-claude-plugin/vibe-api-docs"><img src="https://agentmods.dev/badge/skills/xushuodasd/vibe-claude-plugin/vibe-api-docs.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 22 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,203 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00022 $0.02203
Opus 5 $0.00011 $0.01102
Sonnet 5 $0.00004 $0.00441
Haiku 4.5 $0.00002 $0.00220

Measured 9d ago against content hash 9697504d5bd5, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, from the pricing page.

Security

Grade A, and why

vibe-api-docs scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 9d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

skills/vibe-api-docs/SKILL.md · 190 lines

How it starts

The opening of the file, as written. The whole thing — 190 lines — stays where its author put it; the contents beside it link to each section on GitHub.

接口文档制作工作流

1. 文档目的

规范接口文档的制作流程,确保AI能按用户要求生成并执行工作流,产出高质量的Swagger/OpenAPI、Postman、内部文档平台三种类型的接口文档。

2. 工作流结构

一个简洁高效的接口文档制作工作流应包含:

  • 基本信息:名称、目标
  • 前置步骤:产物检查、依赖项确认
  • 执行步骤:详细的执行流程和顺序
  • 执行建议:专业建议和注意事项
  • 成功标准:任务完成的判定条件
  • 失败处理:异常情况的应对措施
  • 输出成果:明确的交付物和保存位置

3. 执行要求

  • 严格按照步骤执行
  • 与用户保持深度沟通
  • 记录关键信息和结果
  • 遇到异常时按失败处理机制执行
  • 确保输出成果符合用户预期

4. 文档管理

  • 执行后根据实际情况更新文档
  • 进行版本管理,确保使用最新版本

工作流程

前置步骤:产物检查

  1. 检查项目源代码

    • 确认项目源代码是否存在,了解项目的技术栈和架构
    • 如果源代码不存在,提示用户提供源代码或相关信息
  2. 检查架构设计文档

    • 确认text目录下是否存在架构设计文档
    • 如果不存在,提示用户先执行架构设计工作流
  3. 检查数据库设计文档

    • 确认text目录下是否存在数据库设计文档
    • 如果不存在,提示用户先执行数据库设计工作流
  4. 检查README文档

    • 确认项目根目录下是否存在README.md文件
    • 读取README.md文件,了解项目的基本信息
  5. 读取相关文档

    • 读取架构设计文档,了解系统架构和模块划分
    • 读取数据库设计文档,了解数据模型和表结构
    • 读取README.md文件,了解项目的基本信息和功能特点

第一步:项目分析与接口梳理

  1. 项目技术栈分析

    • 分析项目使用的技术栈,确定适合的接口文档生成工具
    • 了解项目的架构和模块划分,确定接口的组织方式
  2. 接口梳理

    • 扫描项目源代码,识别所有API接口
    • 整理接口的HTTP方法、URL路径、请求参数、响应格式等信息
    • 分类整理接口,按照功能模块或业务领域进行组织
  3. 接口关系分析

    • 分析接口之间的依赖关系和调用链
    • 确定接口的权限要求和认证方式
    • 识别接口的错误处理机制和状态码

第二步:Swagger/OpenAPI文档制作

  1. 配置准备

    • 安装Swagger/OpenAPI相关依赖
    • 配置Swagger/OpenAPI生成工具
    • 确定文档的版本和基本信息
  2. 接口定义

    • 根据梳理的接口信息,编写Swagger/OpenAPI规范的接口定义
    • 定义数据模型、请求参数、响应格式等
    • 添加接口描述、标签和分组信息
  3. 文档生成

    • 使用Swagger/OpenAPI工具生成接口文档
    • 验证文档的完整性和准确性
    • 优化文档的结构和格式
  4. 文档测试

    • 使用Swagger UI测试接口文档的可访问性
    • 验证接口定义的正确性
    • 确保文档符合OpenAPI规范

第三步:Postman文档制作

  1. 集合创建

    • 创建Postman集合,按照功能模块组织接口
    • 配置集合的基本信息和认证方式
    • 设置环境变量和全局变量
  2. 接口添加

    • 将梳理的接口添加到Postman集合中
    • 配置接口的请求参数、请求体和头部信息
    • 设置接口的测试脚本和预请求脚本
  3. 文档增强

    • 添加接口描述和使用说明
    • 配置接口的示例请求和响应
    • 添加接口的测试用例和断言
  4. 文档导出

    • 导出Postman集合为JSON或其他格式
    • 验证导出文档的完整性和准确性
    • 确保文档包含所有必要的接口信息

第四步:内部文档平台文档制作

  1. 平台选择

    • 确定使用的内部文档平台(如Confluence、GitBook等)
    • 了解平台的文档格式和要求
    • 配置文档平台的访问权限和版本控制
  2. 文档结构设计

    • 设计内部文档的结构和组织方式
    • 确定文档的目录和章节划分
    • 规划文档的内容和格式

Read the full file on GitHub · 190 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 9d ago First seen · 190 lines · 22 tokens per session scan A 9697504d5bd5

Subscribe to this mod's changes

vibe-api-docs is a skill published in the GitHub repository xushuodasd/VIBE-Claude-Plugin (4 stars, last pushed 2mo ago), licensed MIT. It adds 22 tokens to every session and 2,203 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.