skills.rest
alexander-danilenko
alexander-danilenkoCOMMUNITY
Explore all skills by this author →
GitHub

api-designer

Design API architectures and generate OpenAPI 3.1 specifications for REST and GraphQL services.

14|Updated Feb 5, 2026
Search Tags:#versioning#openapi#rest#graphql#error-handling#pagination#api-design
One-click install
npx skills add https://github.com/alexander-danilenko/ai-skills --skill api-designer-alexander-danilenko
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/alexander-danilenko/ai-skills/tree/main/skills/api-designer
Command: npx skills add https://github.com/alexander-danilenko/ai-skills --skill api-designer-alexander-danilenko

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Help teams design consistent, maintainable APIs and produce complete API contracts so clients and services can integrate reliably without ambiguity or broken upgrades. The skill removes uncertainty in resource modeling, endpoint design, pagination, error handling, and versioning by providing a repeatable, standards-based workflow for REST and GraphQL APIs.

Core Features & Use Cases

  • OpenAPI generation: Produce OpenAPI 3.1 specifications with info, servers, paths, components, schemas, security schemes, responses, and examples.
  • API architecture: Model resources and relationships, define URIs, HTTP methods, and idempotency semantics; recommend pagination, filtering, and sorting strategies.
  • Reliability & evolution: Specify error catalogs (RFC 7807), rate-limiting guidance, authentication flows, and clear versioning and deprecation plans.
  • Use Case: Create a v1 user-management API spec with list/get/create/update/delete endpoints, cursor-based pagination, standardized error responses, and a migration plan to v2.

Quick Start

Create an OpenAPI 3.1 specification for a new user service that includes resource models, endpoints with request/response schemas, pagination, error responses, authentication, and a versioning strategy.

Frequently Asked Questions about api-designer

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

FAQPage Schema
How do I generate an OpenAPI 3.1 specification for a REST API?▼

API error handling uses RFC 7807-compliant error formats to standardize client-facing responses. This skill specifies error catalogs and rate-limiting guidance to ensure services integrate reliably without ambiguity during failures.

What's the best way to handle API versioning and deprecation?▼

Cursor-based pagination manages large result sets by using pointers instead of offsets. This skill recommends pagination, filtering, and sorting strategies for endpoint definitions in your generated API contracts.

Can I design both REST and GraphQL architectures using this approach?▼

Before designing APIs, you need to define resource models and relationships for your target domain. This skill uses these models to generate URI patterns, HTTP methods, and schema definitions for reliable client integration.

How do I create a migration plan for upgrading to a new API version?▼

Creating a migration plan for upgrading API versions involves defining deprecation strategies and mapping endpoint changes. This skill generates versioning plans that ensure clients and services transition reliably without broken upgrades.

Related Skills

Explore More Software Engineering Skills→
ZoyaAfzalZoyaAfzal

sqlmodel

Define SQLModel database schemas with typed CRUD operations and FastAPI integration.

Community
Advanced
dinoudondinoudon

api-documentation

Generates API references and SDK scaffolds from OpenAPI specifications.

Community
Advanced
DexploarerDexploarer
7

api-gateway-configurator

Configure API gateways including Kong with JWT authentication and rate limiting for microservices.

Community
Advanced
dieu-donneedieu-donnee

graphql-architect

Design GraphQL schemas, federation directives, and DataLoader-based resolvers.

Community
Advanced