api-designer

Design durable API contracts with endpoints, schemas, and versioning plans.

22|2|Updated Mar 24, 2026
One-click install
npx skills add https://github.com/jshsakura/awesome-opencode-skills --skill api-designer-jshsakura
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/jshsakura/awesome-opencode-skills/tree/main/skills/api-designer
Command: npx skills add https://github.com/jshsakura/awesome-opencode-skills --skill api-designer-jshsakura

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Design durable API contracts between producers and consumers to prevent integration drift.

Core Features & Use Cases

  • Map actor flows, ownership boundaries, and current contract surface.
  • Propose the smallest contract that supports the required behavior.
  • Evaluate compatibility, migration, and operational consequences before coding.
  • Describe migration paths and deprecation strategies for evolving APIs.

Quick Start

Draft a new API contract for an upcoming service integration, including endpoints, schemas, and versioning plan.

Frequently Asked Questions about api-designer

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

FAQPage Schema
How do I design API contracts to prevent integration drift between producers and consumers?

To prevent integration drift, design durable API contracts by mapping actor flows and ownership boundaries first. You then propose the smallest contract supporting required behavior while evaluating compatibility and migration consequences before any coding begins.

What is the best way to plan API evolution and versioning for multiple service versions?

The best way to plan API evolution is to describe migration paths and deprecation strategies across multiple versions. You evaluate compatibility and operational consequences to maintain durable contracts while satisfying explicit versioning requirements.

How do I draft a new API contract including endpoints, schemas, and versioning plans?

Drafting a new API contract requires proposing the smallest contract surface that supports required behavior. You define endpoints, schemas, and versioning plans by mapping actor flows and evaluating operational consequences before implementation begins.

Can I use API contract design for compatibility reviews and migration scenarios?

Yes, API contract design applies directly to compatibility reviews and migration scenarios across multiple versions. You evaluate compatibility and operational consequences before coding to ensure explicit contract behavior and clear error models are maintained.

What should an API contract include for auth, pagination, and observability signals?

An API contract should include explicit contract behavior, clear error models, versioning, auth, pagination, and observability signals. These elements satisfy requirements for durable contracts and prevent integration drift between producers and consumers.