Skip to main content

API Designer

Skill Verified Active

Use when designing REST or GraphQL APIs, creating OpenAPI specifications, or planning API architecture. Invoke for resource modeling, versioning strategies, pagination patterns, error handling standards.

Purpose

Design robust and well-documented REST or GraphQL APIs with comprehensive OpenAPI 3.1 specifications, covering resource modeling, versioning, and error handling.

Features

  • REST and GraphQL API design guidance
  • OpenAPI 3.1 specification creation
  • Resource modeling and endpoint design
  • Versioning, pagination, and error handling strategies
  • RFC 7807 compliant error response templates

Use Cases

  • Designing new REST APIs
  • Planning GraphQL schemas
  • Creating OpenAPI 3.1 specifications
  • Defining API versioning strategies
  • Standardizing error handling patterns

Non-Goals

  • Writing API implementation code
  • Deploying APIs
  • Testing API functionality
  • Generating client SDKs (though OpenAPI spec supports this)

Workflow

  1. Analyze domain requirements
  2. Model resources and relationships
  3. Design endpoints and URIs
  4. Create and validate OpenAPI 3.1 specification
  5. Plan API versioning and evolution

Practices

  • API Architecture
  • REST Principles
  • OpenAPI Specification
  • Error Handling Standards

Installation

First, add the marketplace

/plugin marketplace add jeffallan/claude-skills
/plugin install claude-skills@fullstack-dev-skills

Quality Score

Verified
99 /100
Analyzed about 19 hours ago

Trust Signals

Last commit13 days ago
Stars9k
LicenseMIT
Status
View Source

© 2025 SkillRepo · Find the right skill, skip the noise.