api-designer

Design REST or GraphQL APIs and produce OpenAPI 3.1 specifications.

10.9k|1.0k|Updated Oct 20, 2025
One-click install
npx skills add https://github.com/Jeffallan/claude-skills --skill api-designer-jeffallan
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/Jeffallan/claude-skills/tree/main/skills/api-designer
Command: npx skills add https://github.com/Jeffallan/claude-skills --skill api-designer-jeffallan

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill guides API design, modeling, pagination, and error handling with OpenAPI specs.

Core Features & Use Cases

  • Resource modeling: Endpoints, schemas, and relationships.
  • Versioning & pagination: Clear API evolution and paging patterns.
  • Error handling: RFC 7807 and consistent responses.

Quick Start

Create a minimal OpenAPI spec for a Users API with pagination.

Frequently Asked Questions about api-designer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I design a REST API with consistent error handling and pagination?

Design REST APIs by modeling resources, defining clear endpoints, and implementing standardized error handling using RFC 7807 format. Add pagination parameters to enable scalable data retrieval, version your API explicitly, and document everything in an OpenAPI 3.1 specification for developer clarity.

What's the best way to structure a GraphQL API with proper versioning and documentation?

Structure GraphQL APIs by modeling relationships between resources, enforcing consistent naming conventions, and implementing robust pagination strategies. Generate OpenAPI 3.1 specifications and define clear versioning approaches to support API evolution while maintaining developer-friendly interfaces.

When should I use OpenAPI 3.1 to document my API design?

Use OpenAPI 3.1 specifications when designing new REST or GraphQL APIs to enforce REST principles, ensure consistent naming, document pagination and versioning strategies, and standardize error handling. OpenAPI serves as the source of truth for scalable, developer-friendly API contracts.

Can I use this for updating an existing API contract without breaking changes?

Yes. Apply API design principles to evolving contracts by modeling updated resources and relationships, defining versioning strategies that maintain backward compatibility, and updating your OpenAPI specification to reflect changes while ensuring authentication schemes and error handling remain consistent.

What authentication approaches work with REST and GraphQL API design?

REST and GraphQL API design accommodates multiple authentication schemes—document your chosen approach (OAuth, API keys, JWT) in your OpenAPI 3.1 specification. Define authentication requirements consistently across endpoints and resources to establish secure, developer-friendly interfaces.