Skills
.Work. You
Rest

code-design-api

Community

Design robust API contracts before coding.

Software Engineering#design#api#openapi#rest#graphql#protobuf#schemas
Authorsirn
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Aligning product goals with implementable API contracts to prevent scope drift and rework by documenting endpoints, data schemas, and versioning rules before coding starts.

Core Features & Use Cases

  • API resource design: Define endpoints, resources, and data shapes for REST, GraphQL, gRPC, or TRPC.
  • Schema generation: Produce OpenAPI/Swagger documents, Protocol Buffers, or TypeBox schemas to codify interfaces.
  • Use Case: When starting a service, generate a complete API contract including endpoints, request/response models, and error formats to guide implementation.

Quick Start

Provide a complete API design specification for the selected protocol (REST, GraphQL, or gRPC) including endpoints, schemas, and sample payloads.

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: code-design-api
Download link: https://github.com/sirn/dotfiles/archive/main.zip#code-design-api

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.