designing-apis

Design REST, GraphQL, and event-driven APIs with versioning and security standards.

9|2|Updated Mar 12, 2026

Search Tags:#design #security #rest #graphql #governance #asyncapi #apis

Ready to run

npx skills add https://github.com/hongmaple0820/agent-academy --skill designing-apis-hongmaple0820

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: designing-apis
Source: https://github.com/hongmaple0820/agent-academy/tree/main/skills/design/designing-apis
Command: npx skills add https://github.com/hongmaple0820/agent-academy --skill designing-apis-hongmaple0820

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Designing robust, secure, and scalable APIs across REST, GraphQL, and event-driven patterns is essential for teams delivering reliable services.

Core Features & Use Cases

Establishes resource-oriented design, versioning, error handling, and security standards for REST, GraphQL, and event-driven APIs.
Provides guidance for protocol selection, API governance, and MCP-enabled toolchains.
Useful for teams designing new public/internal APIs or evolving existing services to modern patterns.

Quick Start

Draft a design plan for a new API using REST and GraphQL that covers resource modeling, versioning, error formats, and security.

Frequently Asked Questions about designing-apis

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

FAQPage Schema

How do I design secure and scalable APIs for REST and GraphQL?▼

To design secure APIs, establish resource-oriented modeling, versioning, error handling, and authentication standards. This approach applies to REST, GraphQL, WebSockets, and event-driven patterns, ensuring robust and scalable services for development teams.

What is the best way to handle API governance and protocol selection?▼

API governance and protocol selection are managed by enforcing standards through OpenAPI and AsyncAPI guidance. This ensures consistent resource design, error formats, and security across new public APIs or internal services evolving to modern patterns.

How do I draft an API design plan covering versioning and error formats?▼

Draft an API design plan by defining resource modeling, versioning strategies, error formats, and security protocols. This covers REST and GraphQL endpoints, applying governance rules and authentication standards to produce a robust service blueprint.

Does this API design approach support event-driven and AsyncAPI patterns?▼

Yes, this API design approach supports event-driven patterns by providing AsyncAPI guidance. It enforces resource design, security, and governance standards specifically for WebSockets and asynchronous event architectures alongside REST and GraphQL.

Can I use this to evolve existing services to modern API patterns?▼

Yes, you can evolve existing services to modern API patterns. It provides guidance for transitioning current architectures to robust, secure standards using REST, GraphQL, and event-driven protocols with proper versioning and governance.

What are the limitations when applying API governance to event-driven architectures?▼

Applying API governance to event-driven architectures requires careful protocol selection between WebSockets and AsyncAPI. Limitations arise when enforcing synchronous REST error handling standards onto asynchronous event streams, necessitating specific resource design adaptations.