api-designer

Name: api-designer
Availability: InStock
Author: Zhao

Generate REST and GraphQL API scaffolds and validation scripts.

69|11|Updated Jan 10, 2026

Search Tags:#design #documentation #api #validation #scaffolding #rest #graphql

Ready to run

npx skills add https://github.com/zhaono1/agent-playbook --skill api-designer-zhaono1

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/zhaono1/agent-playbook/tree/main/skills/api-designer
Command: npx skills add https://github.com/zhaono1/agent-playbook --skill api-designer-zhaono1

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

Streamline REST and GraphQL API design to produce consistent, scalable interfaces.

Core Features & Use Cases

Generate API scaffolds and specifications for REST and GraphQL services.
Validate designs against common patterns (naming, methods, status codes, versioning, auth).
Review and improve existing APIs with structured guidelines and best practices.
Use cases: designing a new user management API, updating an existing service, or performing API reviews across teams.

Quick Start

Design a REST or GraphQL API for a new resource and generate a complete API specification.

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 proper resource naming, status codes, and pagination?▼

Designing a REST API with proper resource naming, status codes, and pagination involves applying standardized design principles to generate consistent, scalable interfaces and validation scripts for your services.

What is the best way to generate scaffolds and specifications for a new GraphQL API?▼

Generating scaffolds and specifications for a new GraphQL API requires streamlining the design process to produce structured interfaces that implement validation checks and best practice patterns.

Can I use this to review and improve existing API designs across teams?▼

Yes, you can use it to review existing API designs across teams by validating current services against common patterns for HTTP methods, versioning, authentication, and structured guidelines.

Does API design validation check authentication and versioning patterns?▼

Yes, API design validation checks authentication and versioning patterns by validating your specifications against common design principles to ensure consistent and scalable interface implementations.

How do I validate checks and generate scaffolds for incremental API improvements?▼

Validating checks and generating scaffolds for incremental API improvements involves reviewing existing services against best practices for resource naming and methods to deliver structured guidelines.