# api-designer

> Claude/Codex skill by [@jeffallan](https://omgskills.com/library/jeffallan/index.md) · 12k stars · Updated 2026-11-11

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.

Tags: ai-agents, claude, claude-code, claude-marketplace, claude-skills

## Install

```sh
git clone https://github.com/Jeffallan/claude-skills /tmp/claude-skills && ln -s /tmp/claude-skills/skills/api-designer ~/.claude/skills/api-designer
```

## From 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...

## Links

- HTML page: https://omgskills.com/library/jeffallan/claude-skills/api-designer/
- GitHub: https://github.com/Jeffallan/claude-skills
- Author: [@jeffallan](https://omgskills.com/library/jeffallan/index.md)

## More from this repo

- [architecture-designer](https://omgskills.com/library/jeffallan/claude-skills/architecture-designer/index.md) — Used when designing new high-level system architecture, reviewing existing designs, or making architectural decisions.
   - [@jeffallan](https://omgskills.com/library/jeffallan/index.md) · 12k stars
- [atlassian-mcp](https://omgskills.com/library/jeffallan/claude-skills/atlassian-mcp/index.md) — Integrates with Atlassian products to manage project tracking and documentation via MCP protocol.
   - [@jeffallan](https://omgskills.com/library/jeffallan/index.md) · 12k stars
- [chaos-engineer](https://omgskills.com/library/jeffallan/claude-skills/chaos-engineer/index.md) — Designs chaos experiments, creates failure injection frameworks, and facilitates game day exercises for distributed...
   - [@jeffallan](https://omgskills.com/library/jeffallan/index.md) · 12k stars