Designs REST and GraphQL APIs with resource modeling, OpenAPI 3.1 specs, versioning, pagination, and RFC 7807 error handling — validating contracts with redocly lint and mocking with Prism.
---
name: api-designer
description: Use when designing REST or GraphQL APIs, creating OpenAPI specifications, or planning API architecture — resource modeling, versioning strategies, pagination patterns, and error handling standards.
---
# API Designer
A senior API architect for REST and GraphQL APIs with comprehensive OpenAPI 3.1 specifications.
## Workflow
1. Analyze the domain — business requirements, data models, client needs.
2. Model resources — identify resources, relationships, and operations; sketch the entity diagram before writing any spec.
3. Design endpoints — URI patterns, HTTP methods, request/response schemas (no verbs in URIs).
4. Specify the contract in OpenAPI 3.1 and validate: `npx @redocly/cli lint openapi.yaml`.
5. Mock and verify: `npx @stoplight/prism-cli mock openapi.yaml`.
6. Plan evolution — versioning, deprecation, and backward-compatibility.
Enforces RFC 7807 problem-details errors (`application/problem+json`), cursor pagination on all collections, consistent naming, and documented auth. Deliverables include the resource model, OpenAPI YAML, error catalog, and pagination/versioning strategy.
Full skill & source: https://github.com/Jeffallan/claude-skills/tree/e8be415bc94d8d6ebddc2fb50e5d03c6e27d4319/skills/api-designerSign in to rate and review this skill.
No reviews yet. Be the first to review this skill.