Skills
.Work. You
Rest

design-api

Community

Design API contracts before implementation

Software Engineering#pydantic#api design#specification#rest api#endpoint design#contract first
Authorg-zenr
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill helps ensure API designs are robust, well-documented, and implementable by providing a structured workflow for defining API contracts before development begins.

Core Features & Use Cases

  • Structured Design Process: Guides users through requirements gathering, endpoint definition, Pydantic model creation, and route organization.
  • Consistency: Promotes uniform API design across projects.
  • Use Case: Before building a new user management service, use this Skill to define all necessary endpoints (e.g., create user, get user, update user), their request/response schemas, and error handling.

Quick Start

Use the design-api skill to design the API contract for a new user authentication service.

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: design-api
Download link: https://github.com/g-zenr/relay-api/archive/main.zip#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.