What is vibe-api-rules?

A workflow for designing API rules and data-model standards from a project's requirements and architecture documents. An API is the defined way software components exchange requests and data.

Use it to plan REST-style API endpoints, request and response formats, data fields and relationships, status codes, and related technical documentation.

It turns project requirements into consistent endpoint, data, validation, error, authentication, and documentation rules for developers to follow.

vibe-api-rules — Skill for Claude Code by xushuodasd

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-rules

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.

README.md

[![agentmods](https://agentmods.dev/badge/skills/xushuodasd/vibe-claude-plugin/vibe-api-rules/github.svg)](https://agentmods.dev/skills/xushuodasd/vibe-claude-plugin/vibe-api-rules)

Your own site

<a href="https://agentmods.dev/skills/xushuodasd/vibe-claude-plugin/vibe-api-rules"><img src="https://agentmods.dev/badge/skills/xushuodasd/vibe-claude-plugin/vibe-api-rules/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.

Your own site · 80×15

<a href="https://agentmods.dev/skills/xushuodasd/vibe-claude-plugin/vibe-api-rules"><img src="https://agentmods.dev/badge/skills/xushuodasd/vibe-claude-plugin/vibe-api-rules.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 1,818 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.

Model	Per session	Once invoked
Fable 5.1	$0.00022	$0.01818
Opus 5	$0.00011	$0.00909
Sonnet 5	$0.00004	$0.00364
Haiku 4.5	$0.00002	$0.00182

Measured 9d ago against content hash 9fe67283af4e, 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-rules 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.

Origin

Copies of this mod

3 near-identical copies found in the catalogue:

vibe-integrate — 98% identical, 233 lines differ
vibe-frontend — 95% identical, 205 lines differ
vibe-review — 94% identical, 268 lines differ

skills/vibe-api-rules/SKILL.md · 154 lines

How it starts

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

API规则文档设计工作流

1. 文档目的

规范API规则文档的设计流程，确保根据需求文档和架构文档制定严格的API和数据模型规则，为前后端开发提供明确的规范。

2. 工作流结构

一个简洁高效的API规则文档设计工作流应包含：

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

3. 执行要求

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

4. 文档管理

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

工作流程

前置步骤：文档检查

检查需求文档：
- 确认./项目文档/需求文档/目录下是否存在PDR需求文档
- 如果不存在，自动执行项目需求分析工作流
检查架构文档：
- 确认./项目文档/技术文档/目录下是否存在框架设计文档
- 如果不存在，自动执行框架设计工作流
读取相关文档：
- 读取PDR需求文档，了解项目的功能需求、非功能需求和技术栈偏好
- 读取框架设计文档，了解系统架构、模块划分和技术选型

第一步：API设计准备

设计目标确认：
- 根据需求文档和架构文档，分析API设计的最佳标准和规范
- 优先选择RESTful规范，确保API设计符合行业最佳实践
- 明确API设计的核心目标：高性能、高可靠性、易于扩展和维护
- 基于架构文档中的技术栈选择，确定API设计的技术方向
API范围界定：
- 根据需求文档和架构文档，确定API的覆盖范围
- 明确需要设计的API模块和功能点
- 制定API设计的优先级和时间计划
技术约束确认：
- 根据架构文档，确定API设计的技术约束和限制
- 确认数据传输格式、认证方式等技术细节
- 了解系统的性能和安全要求

第二步：API设计

RESTful API设计：
- 设计符合RESTful规范的API端点
- 确定HTTP方法、URL路径、请求参数和响应格式
- 设计API的错误处理机制和状态码
数据模型设计：
- 根据需求文档，设计数据模型和数据结构
- 确定数据字段、类型、约束和关系
- 设计数据的验证规则和默认值
API文档结构设计：
- 设计API文档的结构和组织方式
- 确定文档的格式和内容要求
- 设计API示例和使用说明

第三步：API规则制定

命名规范：
- 制定API端点、参数、字段的命名规范
- 确保命名的一致性和可读性
- 避免使用模糊或歧义的命名
数据格式规范：
- 制定请求和响应的数据格式规范
- 确定JSON结构、字段类型和格式要求
- 设计数据验证和错误处理的标准格式
认证授权规范：
- 制定API的认证和授权机制
- 确定访问控制策略和权限管理
- 设计安全的API调用流程
版本管理规范：
- 制定API版本管理策略
- 设计版本控制的实现方式
- 确保API的向后兼容性

第四步：API文档生成

文档内容编写：
- 根据设计结果，编写详细的API规则文档
- 确保文档包含：API设计原则、数据模型、API端点、请求响应示例、错误处理等关键信息
- 对文档内容进行审核和校对
文档格式优化：
- 优化文档的格式和结构，提高可读性
- 添加目录、索引和导航，方便查阅
- 确保文档的一致性和准确性
文档确认：
- 根据需求文档和架构文档，对API规则文档进行审核和确认
- 确保文档内容准确反映API设计的要求和规范
- 验证文档的完整性和一致性，确保符合行业标准

执行建议

系统化设计：采用结构化的方法进行API设计，确保不遗漏关键环节
技术与业务结合：基于需求文档和架构文档，平衡技术可行性和业务需求，提供合理的API设计方案
文档质量：确保API规则文档内容完整、准确、清晰，便于前后端开发团队理解和遵守
风险识别：在API设计过程中识别潜在的风险和挑战，提前制定应对措施
可扩展性：在设计过程中优先考虑API的可扩展性，为未来的功能扩展预留空间
安全性：确保API设计符合安全最佳实践，防止常见的安全漏洞
一致性：保持API设计的一致性，确保命名、格式和行为的统一
标准遵循：严格遵循RESTful规范和行业最佳实践，确保API设计的专业性和可靠性
性能优化：在API设计中考虑性能因素，确保系统的响应速度和吞吐量
可维护性：设计清晰的API结构和文档，确保系统易于维护和更新

Read the full file on GitHub · 154 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.

9d ago First seen · 154 lines · 22 tokens per session scan A 9fe67283af4e

Subscribe to this mod's changes

vibe-api-rules 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 1,818 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.

Backend and APIs Claude Code ai-agent ai-workflow autonomous-coding claude-plugin coding-agent

vibe-api-rules