skills.rest
saeed-vayghan
saeed-vayghanCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-designer

Design scalable REST and GraphQL APIs with OpenAPI 3.1 documentation.

30|7|Updated Jan 13, 2026
Search Tags:#architecture#api design#openapi#rest#developer experience#graphql
One-click install
npx skills add https://github.com/saeed-vayghan/gemini-agent-skills --skill api-designer-saeed-vayghan
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/saeed-vayghan/gemini-agent-skills/tree/main/.gemini/skills/api-designer
Command: npx skills add https://github.com/saeed-vayghan/gemini-agent-skills --skill api-designer-saeed-vayghan

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill addresses the complexity of designing robust, scalable, and developer-friendly APIs by providing expert guidance on REST and GraphQL architecture, documentation, and best practices.

Core Features & Use Cases

  • API Architecture Design: Creates scalable REST and GraphQL APIs.
  • Documentation Generation: Ensures comprehensive API documentation (e.g., OpenAPI 3.1).
  • Developer Experience Focus: Prioritizes consistency, performance, and ease of use for developers.
  • Use Case: A startup needs to design a new e-commerce API. This Skill can guide them through defining resources, endpoints, authentication, and generating the OpenAPI specification.

Quick Start

Use the api-designer skill to design a new REST API for a user management system.

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 scalable REST API for a new application?▼

To design a scalable REST API, provide context on business domain models and client requirements. The process defines resources, endpoints, and authentication while adhering to API-first principles to ensure consistency and developer experience.

What is the best way to structure an e-commerce API for developer experience?▼

The best way to structure an e-commerce API is prioritizing developer experience through consistency and performance. You define resources, endpoints, and authentication, then generate comprehensive OpenAPI specifications for clear documentation.

Can I generate OpenAPI 3.1 documentation when designing GraphQL and REST APIs?▼

Yes, you can generate OpenAPI 3.1 documentation. Comprehensive documentation generation is a core feature alongside REST and GraphQL architecture design, ensuring consistency and ease of use for developers.

Do I need to provide existing API patterns to design a new user management system?▼

Yes, providing existing API patterns is required. Effective API design requires context on business domain models, client requirements, and existing patterns to create scalable and developer-friendly REST and GraphQL architectures.

When should I choose GraphQL over REST for my API architecture?▼

Choosing GraphQL over REST depends on specific client requirements and business domain models. Both protocols are supported for scalable architecture design, allowing you to prioritize consistency, performance, and developer experience based on your use case.

Related Skills

Explore More Software Engineering Skills→
claudcherejiclaudchereji

api-designer

Design scalable REST and GraphQL APIs with OpenAPI 3.1 specifications.

Community
Advanced
belokonmbelokonm
8

api-designer

Design REST and GraphQL APIs and generate OpenAPI 3.1 specifications.

Community
Advanced
rkz91rkz91
264

api-design-principles

Standardize REST and GraphQL API design with schema-first patterns.

Community
Advanced
thesaifalitaithesaifalitai
8

api-designer

Design REST and GraphQL API architectures and generate OpenAPI 3.1 specifications.

Community
Advanced