API Contract 构建
- 作者仓库星标 1
- 作者仓库 claude-skills
Api Contract Builder
Overview
Define the contract before implementation details start to drift.
Core Workflow
- Clarify the consumer, operation, and boundary: endpoint, event, internal service, or public API.
- Define the request shape, required fields, validation rules, defaults, and auth expectations.
- Define the response shape for success and failure, including stable error codes and messages.
- Add examples that make the contract easy to adopt and test.
- Check compatibility, naming consistency, pagination, idempotency, and versioning concerns.
Deliver
- Provide a contract that is implementation-ready.
- Include sample payloads and clear error cases.
- Call out open decisions that affect consumers or backward compatibility.
Guardrails
- Prefer explicit schemas over prose-only descriptions.
- Keep error shapes consistent across endpoints when the system already has a pattern.
- Flag breaking changes early rather than hiding them in a draft.
- 流狐分类
- 设计与多媒体
- 作者声明 Agent
- 未找到明确声明；不据此推断已兼容或已测试
- 静态检查
- 88 / 100 · 启发式扫描，不代表运行安全
- 作者 / 版本 / 许可
- @00PrabalK00 · 未声明 license
- 流狐 Token 估算
- 低消耗
- 流狐接入估算
- 即装即用
- 是否需要外部 API Key
- 未发现要求
- 检测到的系统要求
- 未声明
- 底层运行要求
- 未声明
- 检测到的文件与系统行为
-
- 只读
- 检测到的网络行为
- 仅限本地
- 安装命令数
- 无（仅作为资料）
档案由构建时根据 SKILL.md 与安装命令自动衍生，可能与作者实际意图存在差异。
需要注意： 未限定 allowed-tools，默认拥有全部工具权限。
作者没有在当前 SKILL.md 中定义固定输出样例。Define the contract before implementation details start to drift.
Clarify the consumer, operation, and boundary: endpoint, event, internal service, or public API. Define the request shape, required fields, validation rules, defaults, and auth expectations. Define the response shape for success and failure, including stable…
Provide a contract that is implementation-ready. Include sample payloads and clear error cases. Call out open decisions that affect consumers or backward compatibility.
Prefer explicit schemas over prose-only descriptions. Keep error shapes consistent across endpoints when the system already has a pattern. Flag breaking changes early rather than hiding them in a draft.
# Api Contract Builder
## Overview
Define the contract before implementation details start to drift.
## Core Workflow
1. Clarify the consumer, operation, and boundary: endpoint, event, internal service, or public API.
2. Define the request shape, required fields, validation rules, defaults, and auth expectations.
3. Define the response shape for success and failure, including stable error codes and messages.
4. Add examples that make the contract easy to adopt and test.
5. Check compatibility, naming consistency, pagination, idempotency, and versioning concerns.
## Deliver
- Provide a contract that is implementation-ready.
- Include sample payloads and clear error cases.
- Call out open decisions that affect consumers or backward compatibility.
## Guardrails
- Prefer explicit schemas over prose-only descriptions.
- Keep error shapes consistent across endpoints when the system already has a pattern.
- Flag breaking changes early rather than hiding them in a draft.作者原文负责流程事实；流狐只索引当前章节、要点、文件与命令。
章节 -> Overview → Core Workflow → Deliver → Guardrails
要点 -> Define the contract before implementation details start to drift. · 1. Clarify the consumer, operation, and boundary: endpoint, event, internal service, or public API. · - Provide a contract that is implementation-ready. · - Prefer explicit schemas over prose-only descriptions.
文件/命令 -> 原文未列出明确文件或命令
内容 SHA-256 -> db50902275d1
方法与流程
适用与边界
原文中的明确线索