api-design

Design REST and GraphQL APIs with schemas, error envelopes, and versioning.

Updated Jun 8, 2026
One-click install
npx skills add https://github.com/az9713/atlas-agent-tutorial --skill api-design-az9713
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/az9713/atlas-agent-tutorial/tree/main/ch09_agent_skills/skills/api-design
Command: npx skills add https://github.com/az9713/atlas-agent-tutorial --skill api-design-az9713

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Designing clear and scalable REST and GraphQL interfaces to prevent miscommunications and brittle integrations.

Core Features & Use Cases

  • Define resource models and relationships with stable nouns
  • Specify request/response schemas, validation, and error envelopes
  • Review endpoint ergonomics, versioning, and pagination strategies

Quick Start

Draft a complete API design for a new service by listing resources, outlining schemas, and detailing error handling.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design clear and scalable REST API endpoints?

To design clear REST API endpoints, you define resource models and relationships using stable nouns, specify request and response schemas, and enforce predictable error envelopes to prevent brittle integrations.

What is the best way to structure error handling and pagination in GraphQL APIs?

Structuring error handling and pagination in GraphQL APIs involves defining explicit error envelopes and applying consistent pagination guidance within your schema to ensure scalable and predictable interfaces.

How do I draft a complete API design for a new microservice?

Draft a complete API design for a new microservice by listing resources, outlining request and response schemas, detailing error handling, and defining versioning practices across your web services.

Does this approach support both REST and GraphQL schema definitions?

Yes, this approach supports both REST and GraphQL schema definitions by analyzing and designing interfaces that enforce resource hierarchies, validation, and explicit schemas across web services.

When should I apply explicit versioning practices in API design?

You should apply explicit versioning practices in API design during endpoint structuring to maintain stable resource hierarchies and prevent miscommunications when evolving web service integrations.