Define component interfaces and data contracts before protocol selection.
npx skills add https://github.com/LerianStudio/ring --skill pre-dev-api-design
Please help me install this Agent Skill. Skill: pre-dev-api-design Source: https://github.com/LerianStudio/ring/tree/main/skills/pre-dev-api-design Command: npx skills add https://github.com/LerianStudio/ring --skill pre-dev-api-design
Jumping to implementation without defining component contracts leads to integration failures, inconsistent data structures, and blocked teams. This skill ensures clear, technology-agnostic interface specifications.
The TRD is approved. Use the pre-dev-api-design skill to define the API contracts for our new components.
High-intent search queries and answers about installing and using this skill.
API contracts specify operations, inputs, outputs, and error handling independent of technology. Defining contracts first prevents integration failures, ensures consistent data structures across components, and lets teams develop in parallel without waiting for protocol decisions.
API contracts include operation names and descriptions, input/output schemas, error codes and messages, event payloads, validation rules, rate limits, idempotency requirements, authentication/authorization needs, and a versioning strategy for managing changes and backward compatibility.
When component interfaces and data contracts are defined upfront, teams can build against agreed specifications simultaneously without blocking on implementation details. This accelerates delivery for large features with multiple integrating components.
Yes. Technology-agnostic contract design applies uniformly to internal microservices and external third-party APIs, ensuring consistent interface specifications and integration patterns across your system architecture.
Contracts are abstract, protocol-agnostic specifications of what data flows and operations exist. Protocols are the technology choices for delivery. Contracts come first; protocols are chosen afterward based on operational needs, avoiding rework when requirements change.
API contracts should be defined during pre-development planning, after functional requirements are approved but before implementation begins. This gates contract completeness and prevents teams from discovering integration gaps during coding.
javierhbrCreate OpenSpec Component Implementation Specs with a 5-gate approval process.
Snowflake-LabsA concise summary of your roleplay character: name,</name> personality, and/or behavior, formatted as a single string sentence. Typically不超过50字，此处省略
eleva-labsValidate API implementations against OpenAPI specifications and contracts.
florianbuetowAnalyze distributed system design tradeoffs across six axes using code and configuration artifacts.
