api-designer

Design REST and GraphQL APIs and generate OpenAPI 3.1 specifications.

Updated Feb 11, 2026
One-click install
npx skills add https://github.com/lamb92009/claude-skills --skill api-designer-lamb92009
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/lamb92009/claude-skills/tree/main/api-designer
Command: npx skills add https://github.com/lamb92009/claude-skills --skill api-designer-lamb92009

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Designing robust, scalable REST and GraphQL APIs is error-prone and time-consuming without a structured blueprint.

Core Features & Use Cases

  • API contract design: Model resources, relationships, and operations for clean, client-friendly interfaces.
  • OpenAPI specification: Produce complete OpenAPI 3.1 specs with schemas, examples, and documentation.
  • Versioning & pagination patterns: Define version strategies and consistent pagination to support evolving APIs.

Quick Start

Provide a domain description or existing API requirements to generate a complete OpenAPI specification.

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 and generate an OpenAPI specification?

To design a REST API and generate an OpenAPI specification, provide a domain description or existing API requirements. The tool models resources, applies RESTful principles, and outputs a complete OpenAPI 3.1 compliant spec with schemas and documentation.

What is the best way to handle API versioning and pagination patterns?

The best way to handle API versioning and pagination is to define consistent version strategies and pagination patterns during the design phase. This ensures your evolving API landscape supports clean, client-friendly interfaces without breaking existing contracts.

Does this approach work for designing GraphQL APIs as well as REST?

Yes, this approach works for designing GraphQL APIs as well as REST. You can model resources, relationships, and operations for both protocols, applying consistent error-handling guidelines and interface contracts across the entire API landscape.

How do I model resources and relationships for a clean API contract?

To model resources and relationships for a clean API contract, define your domain entities and their interactions. The design process applies resource modeling and RESTful principles to standardize operations, ensuring the resulting interface is client-friendly.

What do I need to start generating OpenAPI 3.1 documentation?

To start generating OpenAPI 3.1 documentation, you only need to provide a domain description or existing API requirements. No additional dependencies are required to produce standardized interface contracts with comprehensive templates and reference materials.