api-designer

Design REST or GraphQL APIs with automated OpenAPI and GraphQL schema generation.

1|Updated Feb 14, 2026
One-click install
npx skills add https://github.com/ynitto/sandbox --skill api-designer-ynitto
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/ynitto/sandbox/tree/main/.github/skills/api-designer
Command: npx skills add https://github.com/ynitto/sandbox --skill api-designer-ynitto

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

REST / GraphQL API の設計・ドキュメント生成・バリデーション方針を支援する。ユースケース定義や要件が固まった段階で、設計の指針と実装のロードマップを提供します。

Core Features & Use Cases

  • API設計方針の決定とエンティティ洗い出しを支援し、REST/GraphQLの選択肢を明確化する
  • OpenAPI 3.0 および GraphQL スキーマの自動生成・整合性検証を提案する
  • バージョニング戦略、認証/認可設計、セキュリティ要件を包括的に整理する

Quick Start

Describe your API use case and constraints, and the skill will propose endpoints, schemas, and a validation plan.

Frequently Asked Questions about api-designer

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

FAQPage Schema
How do I design and document REST or GraphQL APIs from scratch?

You can generate OpenAPI 3.0 or GraphQL schemas by defining your API use case and constraints. The skill enforces a disciplined execution flow that validates inputs and proposes schemas with consistency checks.

What is the best way to manage API versioning and security during schema design?

Managing API versioning and security involves comprehensively organizing authentication, authorization, and versioning strategies during the schema design phase. This ensures policy-driven reviews and security requirements are integrated directly into the final API documentation.

Can I use this for both frontend and backend API development workflows?

Yes, you can apply this to end-to-end API projects across both frontend and backend development. It supports the entire lifecycle from initial use-case discovery and entity extraction to final schema validation and policy-driven reviews.

How do I validate OpenAPI and GraphQL schema consistency automatically?

You validate OpenAPI and GraphQL schema consistency by applying a policy-driven review process with input validation. This automated mechanism ensures schema generation aligns with your defined constraints and design guidelines.

When should I choose REST versus GraphQL for my API design?

You should choose REST versus GraphQL by evaluating your API use case and constraints to clarify the architectural options. The design process assists with API policy definition and entity extraction to determine the optimal protocol.