design-api

Generate REST, GraphQL, gRPC, and AsyncAPI specifications for microservices.

8|Updated Dec 25, 2025

Search Tags:#design #architecture #API #GraphQL #OpenAPI #gRPC #AsyncAPI

Ready to run

npx skills add https://github.com/wfukatsu/refactoring-agent-for-claude-code --skill design-api

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: design-api
Source: https://github.com/wfukatsu/refactoring-agent-for-claude-code/tree/main/.claude/skills/design-api
Command: npx skills add https://github.com/wfukatsu/refactoring-agent-for-claude-code --skill design-api

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

このエージェントは、マイクロサービスのAPI設計を自動化・標準化します。REST/GraphQL/gRPC/AsyncAPIの仕様書と、API Gateway設計、認証・認可設計を統合的に生成し、設計ドキュメントと実装ガイドを一元管理します。

Core Features & Use Cases

API仕様設計: REST/OpenAPI、GraphQLスキーマ、gRPC/Proto、AsyncAPIイベント定義を生成。
設計ガバナンス: バージョニング方針、ドキュメント戦略、テスト計画を含む設計ガバナンスを提供。
実務ケース: 既存分析結果とターゲットアーキテクチャを入力として、全API層の設計 Artefacts を自動出力。

Quick Start

対象リポジトリのパスを指定して設計を実行します。例: /design-api ./path/to/your/project

Frequently Asked Questions about design-api

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

FAQPage Schema

How do I generate OpenAPI and GraphQL schemas for a microservice architecture?▼

You can generate OpenAPI, GraphQL schemas, Protobuf definitions, and AsyncAPI event definitions by targeting existing analysis results and target architecture to produce comprehensive API specifications.

What's the best way to standardize API governance across REST, gRPC, and AsyncAPI?▼

Standardize API governance across REST, gRPC, and AsyncAPI by enforcing frontmatter-driven configuration, contract-first principles, versioning strategies, and structured artifact generation to feed downstream implementation.

Can I use design-api to generate API Gateway and security design alongside OpenAPI specs?▼

Yes, you can generate API Gateway design and authentication and authorization security guidance alongside OpenAPI, GraphQL, gRPC, and AsyncAPI specifications in a single integrated workflow.

How do I automate API specification generation after refactoring a microservice?▼

Automate API specification generation after refactoring by pointing the design process at your target repository path, using analysis results and target architecture as input to output all API layer design artifacts.

Do I need existing architecture analysis results before generating AsyncAPI event definitions?▼

Yes, existing analysis results and a defined target architecture are required as input to produce accurate AsyncAPI event definitions, OpenAPI specs, GraphQL schemas, and Protobuf definitions.