design-api
API設計エージェント - リファクタリング後のマイクロサービスAPI設計。REST/GraphQL/gRPC/AsyncAPIの仕様書、API Gateway設計、認証・認可設計を策定。/design-api [対象パス] で呼び出し。
npx skills add majiayu000/claude-skill-registry --skill design-api --agent claude-code
Same command for any agent — swap --agent for codex, cursor, copilot.
Weekly change comes from our own snapshots, not the repository page — it measures attention, not adoption.
What it does
Plans and documents a refactored microservice API design across multiple paradigms (REST/GraphQL/gRPC/AsyncAPI), including API gateway and authN/authZ design, plus management strategy.
How it works
- Requires existing analysis results in 01_analysis/ and design targets in 03_design/target-architecture.md and 03_design/scalardb-schema.md (if present).
- Outputs must be written to the directory reports/03_design/ with these files: api-design-overview.md, api-gateway-design.md, api-security-design.md, and API specifications under api-designSpecifications (openapi, graphql schema, grpc proto, asyncapi yaml).
- The execution prompts specify step-by-step tasks from API principles, through service communication patterns, REST OpenAPI design (URL rules and template), GraphQL schema and principles, gRPC proto definitions, AsyncAPI event schemas, to API gateway design.
- The agent is instructed to immediately emit output files after each step completion.
- Uses the tool set and conventions described (e.g., OpenAPI 3.1.0 for REST, GraphQL schema, Proto3 for gRPC, AsyncAPI 3.0.0).
When to use it
- Use when you need a comprehensive API design for a refactored/microservice architecture, covering REST/GraphQL/gRPC/AsyncAPI, plus gateway and security design, and a documented management strategy.
What it can touch
- Outputs are written to: reports/03_design/api-design-overview.md, reports/03_design/api-gateway-design.md, reports/03_design/api-security-design.md, and corresponding spec files under reports/03_design/api-design-specifications/openapi/, graphql/, grpc/, asyncapi/ as applicable.
- It references intermediate inputs under 01_analysis/ and 03_design/ target-architecture and scalardb-schema when present.
Caveats
- Output formats and exact file names are dictated by the steps in the prompt; missing intermediate inputs may affect design content.
- License: MIT of the skill; no licensing risk stated beyond that.
# API Design Agent リファクタリング後のマイクロサービスAPIを設計するエージェントです。 ## 概要 このエージェントは、マイクロサービス設計の結果をもとに、以下を策定します： 1. **API仕様設計** - REST/GraphQL/gRPC/AsyncAPIの仕様書 2. **API Gateway設計** - ルーティング、認証、レート制限 3. **認証・認可設計** - OAuth2/OIDC、RBAC/ABAC 4. **API管理戦略** - バージョニング、ドキュメント、テスト ## 前提条件 以下の中間ファイルが存在すること： - `01_analysis/` 配下の分析結果 - `03_design/target-architecture.md` - `03_design/scalardb-schema.md`（存在する場合） ## 出力先ディレクトリ 設計結果は `reports/03_design/` に出力します。 **重要**: 各ステップ完了時に即座にファイルを出力してください。 ``` reports/03_design/ ├── api-design-overview.md # API設計概要 ├── api-specifications/ # API仕様書ディレクトリ │ ├── openapi/ # OpenAPI (REST) 仕様 │ │ └── [service]-api.yaml │ ├── graphql/ # GraphQL スキーマ │ │ └── [service]-schema.graphql │ ├── grpc/ # gRPC プロトコル定義 │ │ └── [service].proto │ └── asyncapi/ # AsyncAPI (イベント) 仕様 │ └── [service]-events.yaml ├── api-gateway-design.md # API Gateway設計 └── api-security-design.md # 認証・認可設計 ``` ## 実行プロンプト あなたはAPI設計の専門家です。以下の手順で設計を実行してください。 ### Step 1: API設計原則の確認 API設計の基本原則： | 原則 | 説明 | |-----|------| | **Contract First** | 実装前にAPI仕様を定義 | | **Consumer Driven** | 利用者のニーズを優先 | | **Consistency** | 命名規則、エラー形式の統一 | | **Versioning** | 後方互換性を保つバージョン管理 | | **Security by Design** | セキュリティを最初から考慮 | | **D
- 概要
- 前提条件
- 出力先ディレクトリ
- 実行プロンプト
- Step 1: API設計原則の確認
- Step 2: API通信パターンの選定
- Step 3: REST API設計（OpenAPI）
- Step 4: GraphQL設計
- Step 5: gRPC設計
- Step 6: AsyncAPI設計（イベント駆動）
- Step 7: API Gateway設計
- Step 8: 認証・認可設計
- Step 9: API バージョニング戦略
- Step 10: API設計概要の出力
mcp__serena__find_symbol で Controller/Handler クラスを検索 mcp__serena__get_symbols_overview でエンドポイント一覧を取得 npx @stoplight/spectral-cli lint openapi.yaml npx graphql-inspector validate schema.graphql npx @asyncapi/cli validate asyncapi.yaml OpenAPI → HTML npx @redocly/cli build-docs openapi.yaml GraphQL → ドキュメント npx graphql-markdown schema.graphql AsyncAPI → HTML
What does the design-api skill do?
API設計エージェント - リファクタリング後のマイクロサービスAPI設計。REST/GraphQL/gRPC/AsyncAPIの仕様書、API Gateway設計、認証・認可設計を策定。/design-api [対象パス] で呼び出し。
How do I install it?
Run `npx skills add majiayu000/claude-skill-registry --skill design-api --agent claude-code` — it drops the skill into your project so the agent can pick it up. Swap the --agent value for codex, cursor or copilot if you use one of those.
Where does this skill come from?
From majiayu000/claude-skill-registry, a repository with 534 stars. We read it straight from the repository tree rather than a submitted listing, so what you see here is what is actually published.
Is a popular skill a good skill?
Not necessarily. Stars measure attention, not adoption — a repository can trend for a week and be abandoned. That is why we show the weekly change from our own snapshots next to the total, instead of a single flattering number.