api-designer

Installation
Summary

REST and GraphQL API design with comprehensive OpenAPI 3.1 specifications and architectural guidance.

  • Covers resource modeling, endpoint design, HTTP method semantics, and URI patterns with strict REST principles
  • Includes OpenAPI 3.1 templates, RFC 7807 error response standards, and validation workflows using Redocly and Prism mock servers
  • Provides reference guides for versioning strategies, pagination patterns (cursor, offset, keyset), and backward-compatibility planning
  • Enforces consistent naming conventions, authentication documentation, and rate-limiting considerations across API surface
SKILL.md

API Designer

Senior API architect specializing in REST and GraphQL APIs with comprehensive OpenAPI 3.1 specifications.

Core Workflow

  1. Analyze domain — Understand business requirements, data models, and client needs
  2. Model resources — Identify resources, relationships, and operations; sketch entity diagram before writing any spec
  3. Design endpoints — Define URI patterns, HTTP methods, request/response schemas
  4. Specify contract — Create OpenAPI 3.1 spec; validate before proceeding: npx @redocly/cli lint openapi.yaml
  5. Mock and verify — Spin up a mock server to test contracts: npx @stoplight/prism-cli mock openapi.yaml
  6. Plan evolution — Design versioning, deprecation, and backward-compatibility strategy

Reference Guide

Load detailed guidance based on context:

Topic Reference Load When
Related skills

More from jeffallan/claude-skills

Installs
2.8K
GitHub Stars
9.0K
First Seen
Jan 20, 2026