api-designer

Name: api-designer
Availability: InStock
Author: belokonm

Design REST and GraphQL APIs and generate OpenAPI 3.1 specifications.

8|11|Updated Feb 15, 2026

Search Tags:#design #versioning #security #openapi #pagination #api-design #hateoas

Ready to run

npx skills add https://github.com/belokonm/claude-supercode-skills --skill api-designer-belokonm

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/belokonm/claude-supercode-skills/tree/main/api-designer-skill
Command: npx skills add https://github.com/belokonm/claude-supercode-skills --skill api-designer-belokonm

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

REST and GraphQL API architecture guidance for scalable, well-documented interfaces, standardized error handling, and robust versioning.

Core Features & Use Cases

OpenAPI 3.1 specification design and documentation for REST and GraphQL APIs.
API versioning strategies (URL, header, content negotiation) and backward compatibility.
Pagination, filtering, and sorting patterns for large datasets.
Hypermedia-driven design (HATEOAS) for navigable APIs.
Standardized error responses and secure authentication/authorization patterns.

Quick Start

Create an OpenAPI 3.1 spec for a new service starting from requirements and publish it to your API portal.

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 3.1 specification from requirements?▼

To design a REST API and generate an OpenAPI 3.1 specification, define your service requirements and the Skill will architect the endpoints, standardized error schemas, and security patterns to produce a compliant spec for client SDK generation.

What is the best way to implement pagination, filtering, and sorting patterns for large datasets in API design?▼

The best way to implement pagination, filtering, and sorting for large datasets in API design is to apply standardized patterns during the OpenAPI 3.1 specification generation to ensure consistent data retrieval across your microservices architecture.

Does this approach support HATEOAS for navigable API design?▼

Yes, this approach supports HATEOAS for navigable API design by integrating hypermedia-driven structures directly into your OpenAPI 3.1 specifications, allowing clients to dynamically discover and navigate available API actions.

How do I choose an API versioning strategy for backward compatibility?▼

To choose an API versioning strategy for backward compatibility, evaluate URL, header, and content negotiation approaches to determine which method best preserves existing client interactions while scaling your REST or GraphQL architecture.

Can I use this to design GraphQL APIs or is it limited to REST?▼

You can use this to design GraphQL APIs as well as REST APIs, providing architecture guidance, documentation, and robust versioning strategies across both interface paradigms directly within your OpenAPI 3.1 specifications.