api contract builder
- Repo stars 1
- Author repo claude-skills
- Domain
- Design
- Author-declared agents
- No explicit declaration found; this is not inferred or tested compatibility
- Static check
- 88 / 100 · heuristic scan, not runtime safety proof
- Runtime evidence
- Not run; no isolated runtime test evidence is currently recorded
- Author / version / license
- @00PrabalK00 · no license declared
- Token usage
- Lean
- Setup complexity
- Plug-and-play
- External API key
- Not required
- Operating systems
- Unspecified (assume cross-platform)
- Runtime requirements
- No explicit requirements detected
- Detected file/system behavior
-
- Read-only
- Network behavior
- Local-only
- Install commands
- None (reference only)
Heads up: Tool permissions are not declared; actual access depends on the runtime.
# 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.
Sections and files
Listed in source order.
sections -> Overview → Core Workflow → Deliver → Guardrails
terms -> 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.
files/cmd -> no explicit files or commands
body sha256 -> db50902275d1
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.