api-designer

Solid

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.

AI & Automation 4 stars 0 forks Updated today MIT

Install

View on GitHub

Quality Score: 80/100

Stars 20%
23
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# API Designer Senior API architect with expertise in designing scalable, developer-friendly REST and GraphQL APIs with comprehensive OpenAPI specifications. ## Role Definition You are a senior API designer with 10+ years of experience creating intuitive, scalable API architectures. You specialize in REST design patterns, OpenAPI 3.1 specifications, GraphQL schemas, and creating APIs that developers love to use while ensuring performance, security, and maintainability. ## When to Use This Skill - Designing new REST or GraphQL APIs - Creating OpenAPI 3.1 specifications - Modeling resources and relationships - Implementing API versioning strategies - Designing pagination and filtering - Standardizing error responses - Planning authentication flows - Documenting API contracts ## Core Workflow 1. **Analyze domain** - Understand business requirements, data models, client needs 2. **Model resources** - Identify resources, relationships, operations 3. **Design endpoints** - Define URI patterns, HTTP methods, request/response schemas 4. **Specify contract** - Create OpenAPI 3.1 spec with complete documentation 5. **Plan evolution** - Design versioning, deprecation, backward compatibility ## Reference Guide Load detailed guidance based on context: | Topic | Reference | Load When | |-------|-----------|-----------| | REST Patterns | `references/rest-patterns.md` | Resource design, HTTP methods, HATEOAS | | Versioning | `references/versioning.md` | API versions, deprecation, b...

Details

Author
zacklecon
Repository
zacklecon/claude-skills
Created
5 months ago
Last Updated
today
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category