skills.rest
Eigo-Mt-Fuji
Eigo-Mt-FujiCOMMUNITY
Explore all skills by this author →
Website𝕏@EikichiEngineerGitHub

api-designer

Generate OpenAPI, GraphQL SDL, and Protocol Buffer definitions for APIs.

Updated Jan 10, 2026
Search Tags:#GraphQL#REST#OpenAPI#gRPC#API-docs#design-api
One-click install
npx skills add https://github.com/Eigo-Mt-Fuji/portfolio-2026 --skill api-designer-eigo-mt-fuji
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/Eigo-Mt-Fuji/portfolio-2026/tree/main/.claude/skills/api-designer
Command: npx skills add https://github.com/Eigo-Mt-Fuji/portfolio-2026 --skill api-designer-eigo-mt-fuji

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The API Designer AI solves the challenge of crafting consistent, well-documented APIs across REST, GraphQL, and gRPC, and producing high-quality documentation.

Core Features & Use Cases

  • API design across multiple paradigms: REST, GraphQL, and gRPC design guidance.
  • OpenAPI/SDL/Proto generation: Produce OpenAPI specifications, GraphQL SDL, and Protocol Buffer definitions for services.
  • API governance and best practices: Enforce naming conventions, versioning strategies, and security considerations.

Quick Start

Design a simple User API with CRUD endpoints (GET /users, POST /users, GET /users/{id}, PUT/PATCH /users/{id}, DELETE /users/{id}) and generate the OpenAPI specification accordingly.

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 with OpenAPI specifications?▼

REST API design with OpenAPI involves defining endpoints, request/response schemas, and security requirements in a machine-readable specification. This Skill guides you through structuring CRUD operations, naming conventions, versioning, and generates the complete OpenAPI specification artifact for your service.

Can I design GraphQL and gRPC APIs with the same tool?▼

Yes. This Skill supports API design across REST, GraphQL, and gRPC paradigms. It generates GraphQL SDL and Protocol Buffer definitions alongside REST documentation, enabling consistent design patterns and governance across multiple API styles within a single workflow.

What API governance and security considerations does the designer enforce?▼

The Skill enforces naming conventions, versioning strategies, and security best practices across your API design. It integrates these governance standards into generated OpenAPI specifications, GraphQL SDL, and Protocol Buffer definitions to ensure consistency and compliance.

How do I generate machine-readable API documentation?▼

API documentation generation produces OpenAPI specifications, GraphQL SDL, and Protocol Buffer definitions as structured, machine-readable artifacts. These outputs enable API client generation, testing automation, and integration with downstream tooling while maintaining design standards.

What's the best way to maintain consistent API design across teams?▼

Enforcing design standards, naming conventions, and versioning strategies ensures consistency. This Skill generates standardized artifacts (OpenAPI, SDL, Proto) that teams can version control, share, and use as the source of truth for API contracts and documentation.

Related Skills

Explore More Software Engineering Skills→
GeneralJerelGeneralJerel
6

create-api-design

Design REST or GraphQL APIs from feature specifications with schemas and contracts.

Community
Advanced
mgd34msumgd34msu
4

openapi

Generate TypeScript types and client SDKs from OpenAPI 3.1 specifications.

Community
Advanced
vladm3105vladm3105
16

contract-tester

Validate API contracts and detect breaking changes across OpenAPI/AsyncAPI specifications.

Community
Advanced
erichowenserichowens
181

api-architect

Design and validate REST, GraphQL, and gRPC API contracts and architectures.

Community
Advanced