skills.rest
LucasMalessa
LucasMalessaCOMMUNITY
Explore all skills by this author →
GitHub

ring:pre-dev-api-design

Define abstract API contracts with inputs, outputs, errors, and events.

Updated Mar 21, 2026
Search Tags:#standards#gates#data-modeling#contracts#api-design#trd
One-click install
npx skills add https://github.com/LucasMalessa/TheRing --skill ring-pre-dev-api-design-lucasmalessa
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: ring:pre-dev-api-design
Source: https://github.com/LucasMalessa/TheRing/tree/main/pm-team/skills/pre-dev-api-design
Command: npx skills add https://github.com/LucasMalessa/TheRing --skill ring-pre-dev-api-design-lucasmalessa

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Gate-aware API contract design ensures teams define clear component interfaces and data contracts before choosing technologies, preventing integration mistakes, misaligned data contracts, and costly rework later in the cycle.

Core Features & Use Cases

  • Phase-0 API Standards Discovery to pull naming conventions and validation patterns.
  • Per-interface contract definition covering inputs, outputs, errors, and events.
  • Phase-3 BFF considerations when applicable, with abstraction away from protocol details.

Quick Start

Describe the API interactions between two components by listing operations, inputs, outputs, and error conditions in an abstract, protocol-agnostic contract.

Frequently Asked Questions about ring:pre-dev-api-design

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
Why define API contracts before choosing integration technologies?▼

Defining API contracts before technology choices prevents integration mistakes, misaligned data contracts, and costly rework by ensuring teams establish clear component interfaces and data flows early in the cycle.

How do I design protocol-agnostic API contracts for cross-component integrations?▼

To design protocol-agnostic API contracts, list operations with their inputs, outputs, error conditions, and events abstractly, ensuring phase 0 standards discovery for naming conventions and validation patterns is completed first.

What is Phase-0 API standards discovery in data modeling?▼

Phase-0 API standards discovery is the process of pulling naming conventions and validation patterns before defining per-interface contracts, ensuring operations are defined with non-protocol-specific constraints.

When do I need to define API contracts during the technical requirements process?▼

You need to define API contracts during Gate 4 when working with TRD, PRD, and data flows, applying to cross-component integrations to codify interfaces before making technology decisions.

Can I abstract BFF considerations away from protocol details during API design?▼

Yes, you can abstract BFF considerations away from protocol details during Phase-3, ensuring per-interface contract definitions cover inputs, outputs, errors, and events without being tied to specific protocols.

What should be included in per-interface API contract definitions?▼

Per-interface API contract definitions should include operations with specified inputs, outputs, error conditions, and events, along with non-protocol-specific constraints identified during phase 0 standards discovery.

Related Skills

Explore More Software Engineering Skills→
LerianStudioLerianStudio
4

ring:pre-dev-feature-map

Map PRD features into business-focused feature maps with domains and journeys.

Official
Basic
LerianStudioLerianStudio
205

pre-dev-api-design

Define component interfaces and data contracts before protocol selection.

Official
Basic
LerianStudioLerianStudio
205

pre-dev-trd-creation

Create technology-agnostic TRD architecture decisions before implementation choices.

Official
Advanced
manastalukdarmanastalukdar
1

types-generate

Generate TypeScript types from JSON schemas, OpenAPI, GraphQL, and database definitions.

Community
Advanced