api-designer
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.
Install
With your agent
Install OMGSkills skill "jeffallan/claude-skills:api-designer" into this agent's normal skills directory: call the OMGSkills MCP get_install_plan tool for your agent and run the script it returns (it installs only the pinned commit and verifies SKILL.md), and stop if MCP or the pin is unavailable. Do not overwrite or change existing skills without asking me.
Manual command
git clone https://github.com/Jeffallan/claude-skills /tmp/claude-skills && ln -s /tmp/claude-skills/skills/api-designer ~/.claude/skills/api-designerFrom README
API Designer Senior API architect specializing in REST and GraphQL APIs with comprehensive OpenAPI 3.1 specifications. Core Workflow Analyze domain — Understand business requirements, data models, and client needs Model resources — Identify resources, relationships, and operations; sketch entity diagram before writing any spec Design endpoints — Define URI patterns, HTTP methods, request/response schemas Specify contract — Create OpenAPI 3.1 spec; validate before proceeding: npx @redocly/cli lint openapi.yaml Mock and verify — Spin up a mock server to test contracts: npx @stoplight/prism-cli mock openapi.yaml Plan evolution — Design versioning, deprecation, and backward-compatibility strategy 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, breaking...
More from this repo
architecture-designer
Used when designing new high-level system architecture, reviewing existing designs, or making architectural decisions.
atlassian-mcp
Integrates with Atlassian products to manage project tracking and documentation via MCP protocol.
chaos-engineer
Designs chaos experiments, creates failure injection frameworks, and facilitates game day exercises for distributed...