Skills
.Work. You
Rest

api-and-interface-design

Community

Design robust APIs and interfaces.

Software Engineering#typescript#api design#validation#interface design#rest api#contract first
Authoraddyosmani
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill helps you design stable, well-documented interfaces that are hard to misuse, making the right thing easy and the wrong thing hard.

Core Features & Use Cases

  • Contract-First Design: Define interfaces before implementation.
  • Consistent Error Handling: Establish predictable error semantics across your API.
  • Boundary Validation: Ensure data integrity by validating at system edges.
  • Use Case: When designing a new REST API for a task management system, use this skill to define the TaskAPI contract, including endpoints for creating, listing, and updating tasks, along with a consistent error response format.

Quick Start

Use the api-and-interface-design skill to define a TypeScript interface for a new user profile API.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: api-and-interface-design
Download link: https://github.com/addyosmani/agent-skills/archive/main.zip#api-and-interface-design

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.