api-designer

Design REST, GraphQL, and OpenAPI-compliant API specifications.

1|Updated Apr 23, 2026
One-click install
npx skills add https://github.com/mtsatryan/openclaw-ai-agents --skill api-designer-mtsatryan
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/mtsatryan/openclaw-ai-agents/tree/main/api-designer
Command: npx skills add https://github.com/mtsatryan/openclaw-ai-agents --skill api-designer-mtsatryan

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

API teams often struggle to design consistent, scalable interfaces across REST, GraphQL, and OpenAPI, leading to mismatched contracts and brittle integrations.

Core Features & Use Cases

  • Establishes RESTful resource modeling, schema design, and versioning strategies for evolving APIs.
  • Provides GraphQL schema design guidance, including types, inputs, filters, and pagination.
  • Generates OpenAPI/Swagger-compliant specifications and helps maintain up-to-date documentation for client SDKs and testing.
  • Use Case: A team designs a new microservice with REST endpoints and a GraphQL gateway, ensuring consistent contracts and changelog-friendly evolution.

Quick Start

Draft an OpenAPI 3.1 specification for a sample product catalog API.

Frequently Asked Questions about api-designer

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

FAQPage Schema
How do I design REST and GraphQL APIs with consistent contracts?

Design REST and GraphQL APIs with consistent contracts by establishing RESTful resource modeling alongside structured GraphQL schema types, inputs, and filters. This ensures scalable interfaces and prevents mismatched contracts and brittle integrations across microservices.

What is the best way to generate an OpenAPI specification for a new product catalog?

The best way to generate an OpenAPI specification is to draft an OpenAPI 3.1-compliant document for your product catalog API. This produces up-to-date documentation, supports client SDK generation, and satisfies comprehensive governance and testing requirements.

Does this API design approach support versioning and security governance?

Yes, this API design approach explicitly supports versioning and security governance. It provides structured versioning strategies for evolving REST endpoints and applies governance requirements directly into the design artifacts for real-world product ecosystems.

When do I need OpenAPI documentation for my GraphQL gateway?

You need OpenAPI documentation for your GraphQL gateway when maintaining up-to-date contracts for client SDKs and testing. Combining REST endpoints with a GraphQL gateway requires compliant specifications to ensure consistent, changelog-friendly API evolution.

How do I handle GraphQL schema design for pagination and filtering?

Handle GraphQL schema design for pagination and filtering by defining specific types, inputs, and filters within your schema. This structured approach to GraphQL schema design ensures robust querying and consistent data retrieval across your API ecosystem.

Why do API teams struggle with brittle integrations across REST and GraphQL?

API teams struggle with brittle integrations across REST and GraphQL due to inconsistent, unscalable interface designs. Without structured resource modeling and OpenAPI-compliant specifications, mismatched contracts occur, leading to fragile and difficult-to-maintain integrations.