skills.rest
gaebalai
gaebalaiCOMMUNITY
Explore all skills by this author →
Website𝕏@gaebalaiGitHub

api-designer

Design REST, GraphQL, and gRPC APIs and generate OpenAPI specifications.

Updated Aug 23, 2026
Search Tags:#documentation#openapi#rest#graphql#governance#grpc#api-design
One-click install
npx skills add https://github.com/gaebalai/CodeGraphMCPServer --skill api-designer-gaebalai
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/gaebalai/CodeGraphMCPServer/tree/main/.claude/skills/api-designer
Command: npx skills add https://github.com/gaebalai/CodeGraphMCPServer --skill api-designer-gaebalai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps teams design robust RESTful, GraphQL, and gRPC APIs and generate OpenAPI specifications to align product and engineering efforts.

Core Features & Use Cases

  • API design across REST, GraphQL, and gRPC: Create scalable, well-governed interfaces.
  • OpenAPI generation & documentation: Produce API specifications and supporting docs for engineers and clients.
  • API governance & standards: Enforce naming, versioning, and security best practices for teams.
  • Use Case: For a new microservice, generate an OpenAPI spec, domain models, and example requests/responses from a conversation with stakeholders.

Quick Start

Create an OpenAPI spec outline for a new todo service using natural language commands such as "Design a REST API for a todo app with endpoints for tasks and users, and generate an OpenAPI document."

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

You can generate an OpenAPI specification by providing natural language descriptions of your service requirements, such as endpoints and domain models. The skill translates conversational stakeholder inputs into production-ready OpenAPI documents and supporting API documentation.

Can I use this to design APIs for both REST and GraphQL?▼

Yes, you can design APIs for both REST and GraphQL, alongside gRPC. The skill guides the creation of robust, scalable interfaces across these protocols, ensuring consistent API governance and well-structured specifications for your engineering teams.

What is the best way to enforce API governance and naming standards across teams?▼

The best way to enforce API governance is by applying consistent naming, versioning, and security best practices during the design phase. The skill embeds these governance standards directly into your generated OpenAPI specifications to align engineering efforts.

Does this skill help with rapid prototyping for microservices?▼

Yes, the skill supports rapid prototyping for microservices by generating OpenAPI specs, domain models, and example requests and responses. It accelerates the transition from initial stakeholder conversations to production-ready API specifications.

How do I create domain models and example requests for a new service?▼

To create domain models and example requests, describe your service resources and operations in natural language. The skill automatically generates the corresponding domain models, example requests, and example responses within a complete OpenAPI document.

Related Skills

Explore More Software Engineering Skills→
musujmusuj

phase-1-schema

Define project terminology, entities, relationships, and data structures.

Community
Intermediate
mgd34msumgd34msu
4

openapi

Generate TypeScript types and client SDKs from OpenAPI 3.1 specifications.

Community
Advanced
roanbrasilroanbrasil
5

api-gateway-design

Configure API gateways with authentication, rate limiting, and routing.

Community
Advanced
lance-doniflance-donif

data-model-creation

Generate Mermaid class diagrams for visual data relationship modeling.

Community
Advanced